piskvorky/gensim

Add API documentation for public class attributes

Open

#566 创建于 2015年12月22日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Python (15,144 star) (4,349 fork)batch import
Hacktoberfestdifficulty easydocumentationgood first issue

描述

It would be better for API documentation if "public" class attributes, e.g. models.Doc2Vec.docvecs, were explicitly documented as part of the class with examples describing appropriate use. Hopefully, this would help mitigate questions such as this one.

This could be achieved in a few ways with Sphinx:

  1. Via __init__ doc strings with autoattribute (example)
  2. Use Python properties

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonSphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Focus on adding autoattribute or properties to document public class attributes, specifically models.Doc2Vec.docvecs. Examine the Sphinx documentation for autoattribute directive and implement in the appropriate .py files. See linked thread for user questions.
Add API documentation for public class attributes · piskvorky/gensim#566 | Good First Issue