piskvorky/gensim

Add API documentation for public class attributes

Open

#566 opened on 2015年12月22日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (4,349 forks)batch import
Hacktoberfestdifficulty easydocumentationgood first issue

Repository metrics

Stars
 (15,144 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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

コントリビューターガイド