Inconsistencies between docs & integration test examples
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 55/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Compare the documentation examples with the integration test examples, starting with the user-defined axes page linked in the issue and its corresponding test example. Check both the code snippets and the identifiers used for examples and reference images. The synchronization is complete when the docs match the tested examples and the expected plots are picked up.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
With the refactor in #123 the associated bug fix PRs, there have been changes to the examples both in terms of the code snippets themselves and the ID used to tag them (usually a number perhaps with a letter prefix but not always). Therefore much of the docs examples are now out of date from what we test and generate the corresponding plots on. And some plots that should get embedded are not being picked up because the identifier in the reference image no longer matches that quoted (see e.g. https://ncas-cms.github.io/cf-plot/user_defined.html#example-21a-user-defined-axes).
They should be synchronised ASAP so the live docs are accurate.
Ideally we can go beyond that and draw both the docs and integration test code from the same source to ensure they remain in sync going forward too, but I am yet to decide the best solution to achieve this. So for the upcoming bug-fix release I will syncronise only. And later think of the long-term solution.
- Lingua principale
- Python
- Stelle
- 21
- Fork
- 11
- Merge medio
- 2g 21h
- PR unite (30g)
- 7
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun 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 NCAS-CMS/cf-plot
-
docs enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 77/100
-
Add badges to READMEApertadocs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
enhancement
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
dependencies infrastructure installation testing
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
-
testing
Difficoltà 4/5 1-2 giorni Idoneità per principianti 45/100
Tutte le issue di NCAS-CMS/cf-plot
Issue simili
-
fuzz fuzz-unconfirmed
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno
-
ready-for-agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
neilsh/stunt-reel#220 ·
I maintainer di solito rispondono entro 1 giorno
-
[Issue]: use_fp4_cache is accepted but ignored; the launcher always writes FP8 recordsForse già presa @0z5a l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
area: cli priority: p3 size: S type: bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
finos/open-resource-broker#757 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 6 giorni