piskvorky/gensim

Add API documentation for public class attributes

Open

#566 opened on Dec 22, 2015

View on 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
 (No merged PRs in 30d)

Description

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

Contributor guide

Research direction
Explore Sphinx autodoc directives like autoattribute to document class attributes, or consider using Python properties for explicit documentation.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70