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

Clean API docs #603

Closed
7 of 8 tasks
brandenchan opened this issue Nov 18, 2020 · 1 comment · Fixed by #616
Closed
7 of 8 tasks

Clean API docs #603

brandenchan opened this issue Nov 18, 2020 · 1 comment · Fixed by #616
Assignees
Milestone

Comments

@brandenchan
Copy link
Contributor

brandenchan commented Nov 18, 2020

Current pain point:
No easy way to see changes in local env

  • ElasticSearchDocumentStore.init( ) docstring renders incorrectly
  • Better API docs rendering format @PiffPaffM
  • TransformersReader docstring renders incorrectly
  • Better API documentation for PreProcessors
  • ESRetriever.retrieve( ) (and other Sister classes)
  • Generate API docs once more and push to master
  • Add second level navigation to methods - diffrentiate class from methods in right navigation bar @PiffPaffM

optional

  • Link to classes and code
@brandenchan brandenchan self-assigned this Nov 18, 2020
@tholor tholor added this to the #5 milestone Nov 18, 2020
@PiffPaffM
Copy link
Contributor

@brandenchan Here are my changes for the docstrings
image.png

  1. Third level for the docstrings
  2. Add Module as key word
  3. add Objects as keyword

We could replace Objects by class with some more effort, but it is not possible by just configuring the docstring generation.

Moreover, it is not out of the box possible to use the docstrings of a parent for a child.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants