Fix documentation for various modules #2096
Merged
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
piskvorky
changed the title
piskvorky
commented
Jun 20, 2018
gensim/corpora/dictionary.py
Outdated
| @@ -463,7 +458,7 @@ def save_as_text(self, fname, sort_by_word=True): | |||
| fname : str | |||
| Path to output file. | |||
| sort_by_word : bool, optional | |||
| Sort words in lexicographical order before writing them out? | |||
| Sort words in lexicographical order before writing them out. | |||
There was a problem hiding this comment.
-1: bool should be a question, to make it clear what positive answer means (True).
gensim/corpora/wikicorpus.py
Outdated
| dictionary : :class:`~gensim.corpora.dictionary.Dictionary`, optional | ||
| Dictionary, if not provided, this scans the corpus once, to determine its vocabulary | ||
| (this needs **really long time**). | ||
| (**IMPORTANT: this needs really long time**). |
There was a problem hiding this comment.
If it's important, it shouldn't be in brackets :)
really long time => a really long time
gensim/corpora/wikicorpus.py
Outdated
| @@ -546,7 +528,11 @@ def __init__(self, fname, processes=None, lemmatize=utils.has_pattern(), diction | |||
| token_max_len : int, optional | |||
| Maximal token length. | |||
| lower : bool, optional | |||
| Convert all text to lower case? | |||
| Convert all text to lower case. | |||
There was a problem hiding this comment.
-1: should be a question (here and elsewhere).
gensim/utils.py
Outdated
|
|
||
| Yields | ||
| ------ | ||
| list OR np.ndarray | ||
| `chunksize`-ed chunks of elements from `corpus`. | ||
| "chunksize"-ed chunks of elements from `corpus`. |
There was a problem hiding this comment.
Why this change? chunksize is a parameter name (just like corpus, not "corpus").
There was a problem hiding this comment.
in Sphinx, construction
`something`other
without space between "`" and "o" break render & build
- fix bug in smartirs_normalize (old version correct!) - remove persistence test & remove old models from repo (by rename reason)
piskvorky
force-pushed
the
docstring_fixes
branch
from
f57966d
to
a569b76
Compare
menshikh-iv
changed the title
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.
Reviewing the remaining high-profile modules (utils, corpora, interfaces).