Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Issue in generating html output with '&' in @param

Aperta
#1,642 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
42/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
documentation

Direzione di ricerca

Riproducete il caso segnalato usando il docstring @param fornito ed eseguite npm run documentation con Node v20.15.0. Confrontate l’HTML generato con l’output previsto body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification e consultate l’issue correlata #1641 per il contesto; il lavoro è completato quando il tipo viene preservato invece di diventare any.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

For below docstring:

@param { Required<Pick<Model1, 'name'>> & Partial<Model1> } body specification

expectation is to see below format in documentation:

body(Required<Pick<Model1, 'name'>> & Partial<Model1>) specification

but I can see:
body(any) specification

version of documentation pkg: 14.0.3
running documentation: npm run documentation
node version: v20.15.0

Similar issue which was created earlier: https://github.com/documentationjs/documentation/issues/1641

Lingua principale
JavaScript
Stelle
5.8k
Fork
479
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di documentationjs/documentation

Tutte le issue di documentationjs/documentation

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.