Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix API docs #39

Open
12 tasks
mstechly opened this issue May 9, 2024 · 0 comments
Open
12 tasks

Fix API docs #39

mstechly opened this issue May 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mstechly
Copy link
Contributor

mstechly commented May 9, 2024

There are several minor issues with how API docs are being displayed:

  • Base classes should have full path (e.g. BaseModel)
  • Would be nice to add links to the source code.
  • For all the properties remove "returns" and just state what the property is.
  • Add explanation for AnnotatedValue at the top of API docs (and perhaps some other objects which are not explained
  • Make enums list their values
  • Update docstrings to make them more descriptive and helpful, as some are very short (e.g. for Routine
  • Make any mathematical expressions display with Latex
  • Change styling for class methods (such as find_descendants) as right now the header with the class name looks same as Parameters and it's hard to see what's the structure
  • See if any Raises fields are missing from the docstrings
  • compile_routine –> typing is not displaying properly, it should load the types from the overload.
  • AddPassthroughPlaceholder: move the docstring from __init__ to class.
  • While working on Add concepts pages #38 I thought that it would be nice to add links to reference on concepts/precompilation docs page, though I wasn't sure what the syntax is, so decided not to do that right away.
@mstechly mstechly added the documentation Improvements or additions to documentation label May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant