documentationjs / documentationjs/documentation
Issue with options.sort param on build and buildSync functions
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 481
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The JSDoc for the build and buildSync functions in index.js say that options.order may be used to order the documentation. The options.order parameter does not seem to affect the the order. The options.toc parameter does sort the documentation, but is not documented in the JSDocs for these two functions.
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia in index.js dal JSDoc e dalle implementazioni di build e buildSync, quindi riproduci il modo in cui options.order e options.toc influenzano l'ordine dell'output. Il lavoro è completato quando il comportamento dell'ordine e i nomi delle opzioni documentati corrispondono, includendo la documentazione dell'opzione che controlla effettivamente l'ordinamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation, tooling
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100