[api-documenter] namespace and interface with same name documents only the namespace
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation, tooling
Research direction
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.
Written by the indexing model from the issue text.
Description
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 |
- Dominant language
- TypeScript
- Stars
- 6.5k
- Forks
- 708
- Avg merge
- 4d 13h
- Merged PRs (30d)
- 62
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from microsoft/rushstack
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
All issues in microsoft/rushstack
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
IBM/node-sdk-core#373 ·
-
e2e-failure ready-to-code
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
chore
Difficulty 2/5 1-3 hours Newbie friendliness 88/100