Plethora of Examples

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

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Start by reviewing the existing user guide and getting-started documentation, then compare their coverage with the NumPy documentation structure described in the issue. Use the public interface as the issue requests and relate the examples to #145. Done means expanding the sparse user guide with simple usage examples while maintaining the existing contributor guidance.

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

Descrizione

documentation good first issue

The referee for sure has a point we are lacking examples in user manual. He had an even stronger point before we were completely lacking a user manual. We simply performed the minimal task of providing something, now we should improve a lot over that something.

Being mainly a library, we want have examples of "you run this way, you'll get this output", but we need simple examples nevertheless.

As usual, NumPy is something to look at for a good pattern to imitate.
The documentation has 4 different sections: https://numpy.org/doc/

  1. API Reference: this we have (docstrings), for sure we can improve, but it is already good enough (the only one...)
  2. User Guide: we attempted to provide, but there is very little
  3. Getting Started: in a sense we have this and not the former one, but the truth is that we have only one out of two, with a very generic target (for us users are all the same at the moment, essentially because we have no one, so they might all be considered "Absolute Beginners")
  4. Contributor's Guide: not that many candidate contributors out there, but something minimal might be useful - and something we have Benchmarks and rest of "development", together with Contributing Guidelines, so we should just need to maintain it (no need to expand at the moment, we'll cross that bridge when we come to it)

Related to #145 (examples should rely on the public interface, and, if possible, "cover" it)

Lingua principale
Python
Stelle
13
Fork
9
Merge medio
6g 16h
PR unite (30g)
3

Preparare l'ambiente

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 NNPDF/eko

Tutte le issue di NNPDF/eko

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.