piskvorky/gensim

Add API documentation for public class attributes

Open

#566 aperta il 22 dic 2015

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (4349 fork)batch import
Hacktoberfestdifficulty easydocumentationgood first issue

Metriche repository

Star
 (15.144 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora le direttive Sphinx autodoc come autoattribute per documentare gli attributi della classe, o considera l'uso delle proprietà Python per una documentazione esplicita.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70