API theme

Aperta
  • Qualcosa non va?
#120 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
tex
Ambito
documentation

Direzione di ricerca

Inizia dal punto di ingresso attuale della documentazione dell'API e analizza come le funzioni sono raggruppate nelle pagine. Confronta la sua organizzazione con lo stile della documentazione di numpy; il lavoro è completato quando ogni funzione ha la propria pagina di documentazione dell'API.

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

Descrizione

The current API documentation puts all the functions in the same web page, which seems not clear. It would be better to use the same style as numpy documentation where each page contains only one function.

Lingua principale
TeX
Stelle
43
Fork
87
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 pyscf/pyscf.github.io

Tutte le issue di pyscf/pyscf.github.io

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.