Refactor docstrings for gensim.scripts. Partial fix #1665
#1792
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
menshikh-iv
moved this from In Progress (common)
to Yuri (in progress)
in Documentation
menshikh-iv
suggested changes
Dec 26, 2017
gensim/scripts/glove2word2vec.py
Outdated
| Parameters | ||
| ---------- | ||
| GloVe_file : str | ||
| Input file in GloVe format. |
There was a problem hiding this comment.
"Input file" -> "Path to input file"
gensim/scripts/glove2word2vec.py
Outdated
| word2vec_file : str | ||
| Output filename to be converted in word2vec format. | ||
|
|
||
| Produces |
There was a problem hiding this comment.
This is a valid section for sphinx?
| @@ -5,18 +5,36 @@ | |||
| # Copyright (C) 2016 Manas Ranjan Kar <manasrkar91@gmail.com> | |||
There was a problem hiding this comment.
Look at https://pythonhosted.org/sphinxcontrib-programoutput/, this should be helpful for documenting CLI applications 👍
Add it to current sphinx-build and test, how it works
menshikh-iv
changed the title
gensim.scripts. Fix #1665
…cs. setup.py and conf.py need to add sphinxcontrib.programoutput as new extension
menshikh-iv
changed the title
gensim.scripts. Fix #1665gensim.scripts. Partial fix #1665
sj29-innovate
pushed a commit
to sj29-innovate/gensim
that referenced
this pull request
Feb 21, 2018
…iskvorky#1792) * drafts docstrings * docstrings added, Ivan need to check format * fixed links, headers, typos and etc * docstrings moved to scripts inside and appear as console output in docs. setup.py and conf.py need to add sphinxcontrib.programoutput as new extension * update configs with new extension sphinxcontrib.programoutput * fix doc[1] * finish with glove2word2vec (RawFormatter + examples) * more examples for glove2word2vec * simplify example for g2w2v + fix for w2v2t * fix segment_wiki * revert make_wikicorpus (should be fixed in refactoring) * revert [2]
6 tasks
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.
Hi,
here's docstrings for scripts #1665
I'm not sure about docstring format. So let's find appropriate way to doc scripts and fix it.