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.

Sign up for GitHub

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

Jump to bottom

Turn off support of Google Style docstrings #1663

Closed
anotherbugmaster opened this issue Oct 30, 2017 · 4 comments · Fixed by #2106
Closed

Turn off support of Google Style docstrings #1663

anotherbugmaster opened this issue Oct 30, 2017 · 4 comments · Fixed by #2106
Labels
difficulty easy Easy issue: required small fix documentation Current issue related to documentation

Comments

@anotherbugmaster
Copy link
Contributor

anotherbugmaster commented Oct 30, 2017 •
edited by menshikh-iv
Loading

All docstrings should be refactored first

To prevent contributors from using Google Style docstrings, we need to set

napoleon_google_docstring = False,

like explained here.
@menshikh-iv menshikh-iv added documentation Current issue related to documentation difficulty easy Easy issue: required small fix good first issue Issue for new contributors (not required gensim understanding + very simple) labels Oct 30, 2017
@anotherbugmaster anotherbugmaster removed the good first issue Issue for new contributors (not required gensim understanding + very simple) label Oct 30, 2017
@menshikh-iv menshikh-iv added the good first issue Issue for new contributors (not required gensim understanding + very simple) label Oct 30, 2017
@menshikh-iv menshikh-iv removed the good first issue Issue for new contributors (not required gensim understanding + very simple) label Oct 30, 2017
@kaustubhhiware
Copy link

Can I take this up @menshikh-iv @anotherbugmaster ?

@menshikh-iv
Copy link
Contributor

@kaustubhhiware no, because we didn't finished with docstrings yet

@jxub
Copy link

jxub commented Mar 22, 2018

@anotherbugmaster FYI, #1605 seems closed. Is this one up for grabs?

@menshikh-iv
Copy link
Contributor

@jxub we'll make it after finishing all docstrings (that happens soon, I hope)

@menshikh-iv menshikh-iv mentioned this issue Jun 27, 2018
Merged
menshikh-iv added a commit that referenced this issue Jun 27, 2018
@menshikh-iv
Disable google-style docstring support. Fix #1663 (#2106)
37e4997
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty easy Easy issue: required small fix documentation Current issue related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Disable google-style docstring support. piskvorky/gensim
4 participants
@anotherbugmaster @kaustubhhiware @menshikh-iv @jxub