Documentation fixes

Aperta
#95 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start by inventorying the Python source files, comments, and existing docstrings covered by this issue. Review the project's current Sphinx documentation conventions before deciding how to describe arguments and outputs. Done means comments are converted where appropriate, documented functions cover their interfaces, and previously undocumented methods have clear docstrings.

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

Descrizione

maintenance

A lot of documentation are comments, not documentation strings – they should be changed.

Most documentation strings don't actually document what the different arguments are and what the expected outputs are – using the sphinx format to document that would be nice.

Finally, many methods and functions are not documented at all, that should also be fixed.

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 tlsfuzzer/python-ecdsa

Tutte le issue di tlsfuzzer/python-ecdsa

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.