Add napolean sphinx extension to allow parsing docstrings in various formats #1411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…formats See the discussion on mailinglist: <https://groups.google.com/forum/#!topic/gensim/M0N4mBgi9TY>
|
Thank you @rasto2211. Did you hear about automated tools for docstring checking (in google style)? It's very important tool for us -- it will help us check docstrings and keep everything consistent in new PRs, automatically. |
|
To be honest, I don't know of any tool like that. There is a tool called pydocstyle which can check if docstrings are in numpy style but I did not manage to find anything like that for google style docstrings. I know that google is using pylint for checking the coding style and their config file is here, but I don't think that it checks docstrings formats. It seems that pylint only warns you if there is no docstring for a function/class. |
|
Thank you @rasto2211, congratulations on your first PR 🥇 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See the discussion on mailinglist:
https://groups.google.com/forum/#!topic/gensim/M0N4mBgi9TY
I also updated wiki:
https://github.com/RaRe-Technologies/gensim/wiki/Developer-page#documentation
If you want to see what has changed then take a look at the documentation of
gensim.models.atmodel.AuthorTopicModel.update. The docstring is written in a Google style but not really properly that's the reason why it looks a bit weird. Gensim is full of docstrings in various custom made docstring formats.