[api-documenter] namespace and interface with same name documents only the namespace
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 42/100
- Issue-Typ
- Bug
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- typescript
- Bereich
- documentation, tooling
Rechercherichtung
Reproduce the collision with the two npx commands, using npm/api-extractor.json as the input configuration and tmp and docs/js as the output locations. Inspect how @microsoft/api-documenter markdown names and writes pages for the namespace and interface. Done means both declarations have distinct Markdown pages and links resolve to the correct documentation.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Summary
I have an interface named mynamespace.Persistence and also a namespace with more classes mynamespace.persistence.Stuff the markdown files written in markdown mode all have lowercase names so these end up with the same name and I only end up with a file documenting the namespace not the interface. I get a link to what should be the interface documentation, but it's the same page as the namespace, having been (it seems) overwritten.
Repro steps
Have a namespace and interface with same names (different case).
npx @microsoft/api-extractor run -c npm/api-extractor.json
npx @microsoft/api-documenter markdown -i tmp -o docs/js/
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question | Answer |
|---|---|
| Operating system? | Linux |
| Documentation target? | Markdown |
| Would you consider contributing a PR? | Yes |
- Vorherrschende Sprache
- TypeScript
- Sterne
- 6.5k
- Forks
- 708
- Ø Merge
- 4 T. 7 Std.
- Gemergte PRs (30 T.)
- 61
Entwicklungsumgebung
Die Einrichtungsdateien dieses Projekts haben wir noch nicht geprüft. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoft/rushstack
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
microsoft/rushstack#5971 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
microsoft/rushstack#5902 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
microsoft/rushstack#5839 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
microsoft/rushstack#5683 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in microsoft/rushstack
Ähnliche Issues
-
resources
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
railmapgen/rmg-palette#2445 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
danielmiessler/LifeOS#2242 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
good first issue hacktoberfest help wanted translation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
callstackincubator/appduct#129 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100