Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Docstrings

Aperta
#92 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia riproducendo l’esempio documentato con help(odml.Section) in iPython ed esamina le docstring di init per le classi pertinenti. Determina se le docstring debbano essere ripetute o spostate nella classe, quindi verifica che help(odml.Section) visualizzi le informazioni previste.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

v1.4

While writing the tutorial I realized that the help function in iPython does not always provide proper information. I think the docstrings of the init functions need to be repeated or moved to the class.

Example:
help(odml.Section)
-> returns
Section(*args, **kwargs)

Lingua principale
Python
Stelle
25
Fork
30
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di G-Node/python-odml

Tutte le issue di G-Node/python-odml

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.