Skip to content

[Epic] Better documentation #836

Open
@shin-

Description

@shin-

Main takeaways:

  • API docs are poorly formatted and difficult to navigate.
  • Some users find it valuable to have the documentation closer to the code itself.
  • More information could be given about the behavior of our methods (exceptions raised, etc.)
  • User guides in addition to functional documentation could prove useful.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions