Plethora of Examples
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
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/
- API Reference: this we have (docstrings), for sure we can improve, but it is already good enough (the only one...)
- User Guide: we attempted to provide, but there is very little
- 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")
- 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
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NNPDF/eko
-
Update yaml reader in rustApertarust
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
I maintainer di solito rispondono entro 1 giorno
-
physics
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
-
physics
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
I maintainer di solito rispondono entro 1 giorno
-
Improve Python workflowApertabenchmarks
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
I maintainer di solito rispondono entro 1 giorno
-
Centralize Maturin workflowsApertabenchmarks rust
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
CI flake: test-windows times out spawning Node in tests/test_antigravity_node_hooks.py (develop red)Apertaarea/ci P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 2 giorni
-
benchmark
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 79/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
mozilla-ai/cq#601 ·
I maintainer di solito rispondono entro 1 giorno
-
Bump Python to 3.14 or 3.15Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno