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 documentation for various modules #2096

Merged
merged 34 commits into from
Jun 22, 2018
Merged

Fix documentation for various modules #2096

merged 34 commits into from
Jun 22, 2018

Conversation

piskvorky
Copy link
Owner

@piskvorky piskvorky commented Jun 20, 2018

Reviewing the remaining high-profile modules (utils, corpora, interfaces).

@piskvorky piskvorky changed the title Documentation fixes to utility modules Documentation fixes to various modules Jun 20, 2018
Copy link
Owner Author

@piskvorky piskvorky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catches! But please reverse the bool params. The "If True" is both unnecessary and harder to read.

@@ -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.
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1: bool should be a question, to make it clear what positive answer means (True).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

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**).
Copy link
Owner Author

@piskvorky piskvorky Jun 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's important, it shouldn't be in brackets :)

really long time => a really long time

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -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.
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1: should be a question (here and elsewhere).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

gensim/utils.py Outdated

Yields
------
list OR np.ndarray
`chunksize`-ed chunks of elements from `corpus`.
"chunksize"-ed chunks of elements from `corpus`.
Copy link
Owner Author

@piskvorky piskvorky Jun 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change? chunksize is a parameter name (just like corpus, not "corpus").

Copy link
Contributor

@menshikh-iv menshikh-iv Jun 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in Sphinx, construction

`something`other

without space between "`" and "o" break render & build

menshikh-iv and others added 6 commits June 21, 2018 07:27
- fix bug in smartirs_normalize (old version correct!)
- remove persistence test & remove old models from repo (by rename reason)
@menshikh-iv menshikh-iv changed the title Documentation fixes to various modules Fix documentation for various modules Jun 22, 2018
@menshikh-iv menshikh-iv merged commit cc441b7 into develop Jun 22, 2018
@menshikh-iv menshikh-iv deleted the docstring_fixes branch June 22, 2018 01:36
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 this pull request may close these issues.

2 participants