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

Add metadata to WikiCorpus docs #1161

Closed
tmylk opened this issue Feb 22, 2017 · 4 comments
Closed

Add metadata to WikiCorpus docs #1161

tmylk opened this issue Feb 22, 2017 · 4 comments
Labels
difficulty easy Easy issue: required small fix documentation Current issue related to documentation

Comments

@tmylk
Copy link
Contributor

tmylk commented Feb 22, 2017

As mentioned in this comment metadata parameter is not well-document in the WikiCorpus.

It needs to be added to init and to the wiki script parameters.

@tmylk tmylk added documentation Current issue related to documentation difficulty easy Easy issue: required small fix labels Feb 22, 2017
@kirit93
Copy link
Contributor

kirit93 commented Feb 22, 2017

Hi! I'd like to get started contributing to Gensim and I thought this would be a nice way to start. As I've understood the issue, documentation about the metadata parameter is required here https://github.com/RaRe-Technologies/gensim/blob/develop/gensim/corpora/wikicorpus.py#L261 right?
I'm unsure about how to add documentation to the wiki script. If you could point me in the right direction, I'd really appreciate it. Thanks!

@tmylk
Copy link
Contributor Author

tmylk commented Feb 22, 2017

Hi. Welcome! Could you please make your question more precise?

@kirit93
Copy link
Contributor

kirit93 commented Feb 22, 2017

When you said metadata documentation needs to be added to init, does it need to be added to the comments under the __init__ function definition?

@tmylk
Copy link
Contributor Author

tmylk commented Feb 22, 2017

Yes, that is the docstring. It is also mentioned in tutorials and on top of the file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty easy Easy issue: required small fix documentation Current issue related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants