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

LsiModel ( & maybe others) should generate docs for essential special-methods (like __getitem__ etc) #3291

Closed
gojomo opened this issue Feb 22, 2022 · 0 comments · Fixed by #3307
Assignees
Milestone

Comments

@gojomo
Copy link
Collaborator

gojomo commented Feb 22, 2022

Answering someone's LSI question, I noticed that none of the Gensim docs around LSI point out that you need to use bracket-indexed access to get the LSI topics for a BoW doc - not the class doc, or the tutorial. A user would need to know or intuit that's the Gensim convention from elsewhere.

Without understanding the auto-doc config exactly, I suspect LsiModel needs some config file like the one in poincare.rst:

https://github.com/RaRe-Technologies/gensim/blob/develop/docs/src/models/poincare.rst

...which enabled doc-generation for special-members. Perhaps, it'd even be appropriate to toggler generation of such docs globally, if possible, given the centrality of the bracket-accessing to some of the Gensim classes' APIs. If that's not possible/wise, a survey of which classes – (a) implement specials that are essential to thei use; & (b) don't yet have doc-comments, or generate web docs for those methods – should be done with the oversights fixed.

@piskvorky piskvorky added this to the Next release milestone Feb 22, 2022
@piskvorky piskvorky self-assigned this Feb 22, 2022
@piskvorky piskvorky changed the title LsiModel ( & maybe others) should genenrate docs for essential special-methods (like __getitem__ etc) LsiModel ( & maybe others) should generate docs for essential special-methods (like __getitem__ etc) Mar 17, 2022
piskvorky added a commit that referenced this issue Mar 18, 2022
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 a pull request may close this issue.

2 participants