[api-documenter] namespace and interface with same name documents only the namespace
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- documentation, tooling
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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 |
- 主要语言
- TypeScript
- 星标
- 6.5k
- 派生
- 708
- 平均合并
- 4 天 7 小时
- 30 天内合并 PR
- 61
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
microsoft/rushstack 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
microsoft/rushstack#5971 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
microsoft/rushstack#5902 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
microsoft/rushstack#5839 · 1 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
microsoft/rushstack#5683 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 45/100
维护者通常 1 天内回复
查看 microsoft/rushstack 的全部 Issue
相似的 Issue
-
resources
难度 2/5 1-3 小时 新手友好度 72/100
railmapgen/rmg-palette#2445 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 88/100
danielmiessler/LifeOS#2242 ·
维护者通常 5 天内回复
-
good first issue hacktoberfest help wanted translation
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
callstackincubator/appduct#129 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 88/100