documentationjs / documentationjs/documentation
module name inference should depend on current directory?
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
A bit of odd behavior from standard JSDoc:
If the module name is not provided, it is derived from the module's path and filename. For example, suppose I have a file
test.js, located in thesrcdirectory, that contains the block comment/** @module */. Here are some scenarios for running JSDoc and the resulting module names for test.js:Derived module names if none is provided.
# from src/ jsdoc ./test.js # module name 'test' # from src's parent directory: jsdoc src/test.js # module name 'src/test' jsdoc -r src/ # module name 'test'
Should documentation.js emulate this?
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 riproducendo i tre esempi di comandi JSDoc nell’issue e ispeziona il punto di ingresso dell’inferenza del nome del modulo che esercitano. Confronta l’output di documentation.js con i nomi indicati, quindi aggiungi o aggiorna la coverage in modo che l’inferenza rifletta la directory di lavoro corrente e il comportamento dell’invocazione ricorsiva.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100