Skip to content

Documentation #33

Description

@MelbourneDeveloper

Add documentation to all the public elements in both libraries.

AI makes this easy. Just follow these guidelines:

  • Give the AI examples of the existing doco so it can follow the style
  • Tell the AI that this is part of charts_flutter because most of them know the library well
  • Tell the AI to fill in missing documentation, but not modify existing documentation
  • Include all of the code in the context so it's more accurate
  • Claude Sonnet or Opus are great models. The newer ChatGPT models are also pretty good

Keep it consistent and check for errors.

You don't have to do it all at once. Just a few files at time would be help.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions