Validator reference (bounds<>/element_bounds<> etc.) is hard to find inside the README
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
- Ambito
- documentation
Direzione di ricerca
Read the README sections on YAML syntax, validators by type, and C++/Python codegen usage, then check linked pull request #391 for work already underway. The issue suggests a dedicated docs/ reference but does not define its structure or scope; done would mean validation rules are easier to find and link to than in the current README.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Noticed #347 and #363 both trace back to the same thing: the validation rules (bounds<> vs element_bounds<>, deprecated header paths, etc.) only live in the README, so there's no way to search or link directly to "which validators apply to array types" without Ctrl-F through a 29K-character file.
Small example: the bounds<>/element_bounds<> mixup in #347 is exactly what a per-type validator reference page would catch at write time (the compiler doesn't catch it either, per that issue). Right now the only doc for it is a code block buried mid-README.
Not filing this as a bug, just flagging it as a maintenance thing. With 47 contributors and commits landing every few days, a dedicated docs/ (even just split by section: YAML syntax, validators by type, C++/Python codegen usage) would probably cut down on issues like #347 that are really "the reference doc wasn't discoverable," not code bugs.
Happy to share what a structured split of the current README content looks like if that's useful. Not attaching it here since it's tangential to this repo's issue tracker.
- Lingua principale
- Python
- Stelle
- 385
- Fork
- 81
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
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 PickNikRobotics/generate_parameter_library
-
documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
Feature: Enum supportAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 45/100
PickNikRobotics/generate_parameter_library#392 · 2 commenti ·
-
GCC 15 emits -Wfree-nonheap-object for generated string one_of validationForse già presa @tylerjw l’ha presa 16 giorni fa. Aperta
PickNikRobotics/generate_parameter_library#389 · 1 commento · 1 assegnatario ·
-
Feature request: math in the yamlForse già presa @tylerjw l’ha presa 16 giorni fa. Aperta
PickNikRobotics/generate_parameter_library#381 · 2 commenti · 1 reazione · 1 assegnatario ·
-
`.inf` not within floating point rangeForse già presa @christianrauch l’ha presa 67 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 30/100
PickNikRobotics/generate_parameter_library#376 · 3 commenti ·
Tutte le issue di PickNikRobotics/generate_parameter_library
Issue simili
-
fix formatting of the sample database page of the docsForse già presa @Aaqibhafeezkhan l’ha presa oggi. Apertadocumentation good first issue help wanted
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
chaoss/CollectOSS#544 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
area/plugin good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
kestra-io/plugin-soda#137 ·
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 62/100
ibm-granite/granite.build#504 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno