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 WmdSimilarity documentation #2217

Merged
merged 3 commits into from
Oct 8, 2018

Conversation

jagmoreira
Copy link
Contributor

Fix #2112, update the docstrings for the corpus variable in docsims.WmdSimilarity to reflect the proper input format: list of list of tokens.

Also add missing curly braces in other docstrings in that module.

@menshikh-iv
Copy link
Contributor

@jagmoreira hello, thanks for PR, please also fix docstring example (pass corpus in correct format like mentioned in original issue & make sure that python -m doctests gensim/similarities/docsim.py passed correctly.

@jagmoreira
Copy link
Contributor Author

jagmoreira commented Oct 7, 2018

I fixed the docstring example.
The doctest command gave only some FutureWarnings coming from matutils.py:

Warnings went away after rebasing.

@jagmoreira jagmoreira force-pushed the update-wmdsimilarity-docs branch from ddea390 to e775c25 Compare October 7, 2018 18:22
@jagmoreira
Copy link
Contributor Author

jagmoreira commented Oct 7, 2018

Fixed merge conflicts in my branch.

@menshikh-iv
Copy link
Contributor

Thank you @jagmoreira, congratz with your first contribution! Happy hacktoberfect 🚀

@menshikh-iv menshikh-iv changed the title Update documentation for WmdSimilarity Fix WmdSimilarity documentation Oct 8, 2018
@menshikh-iv menshikh-iv merged commit 21ef524 into piskvorky:develop Oct 8, 2018
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