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.