-
Notifications
You must be signed in to change notification settings - Fork 718
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
Document the individual modules better #6
Comments
I'd love to help with this! |
That would be greatly appreciated! Preferably, this part would be directly in the code as docstrings since that makes it much less likely to forget about updating the docs on code changes. It would also automatically serve as a partial documentation of the API (#7). I'll have to think a bit about how to make it easily accessible, but that's down the line anyway. |
Numpy docstrings are a great human- and machine- readable format for docstrings: https://numpydoc.readthedocs.io/en/latest/format.html |
Unfortunately, numpydoc doesn't support proper type hints: numpy/numpydoc#196 The ideal solution would be something like https://github.com/agronholm/sphinx-autodoc-typehints/issues/149 I think. I haven't done much research on this though (yet). |
The modules are currently not documented very well, especially their limitations (e.g. Twitter not discovering retweets).
The text was updated successfully, but these errors were encountered: