microsoft / microsoft/TypeScript
JSDoc comments for async_hooks are confusing/misleading
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
Acknowledgement
- I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.
Comment
The JSDoc comments from the async_hooks module state not to use the module, and then go on to immediately suggest an "alternative" that is in the module itself.
We strongly discourage the use of the
async_hooksAPI
- AsyncLocalStorage
If you look at the node.js docs, it makes sense because these two things are on separate pages, but in TS, this warning is shown on import { AsyncLocalStorage } from 'node:async_hooks';
This might be a larger codegen/docs issue as well for other modules that have multiple doc pages.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit zu ermitteln, wie der JSDoc für das Modul node:async_hooks generiert wird, und vergleiche seine Ausgabe mit den separaten Node.js-Dokumentationsseiten. Prüfe, ob die Warnung am Modul oder an einzelnen Exporten, einschließlich AsyncLocalStorage, angebracht ist. Als erledigt gilt die Aufgabe, wenn die für TypeScript bestimmte generierte Dokumentation die Modulwarnung nicht mehr irreführend so darstellt, als würde sie für diesen Export gelten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- node.js, typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100