Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[api-documenter] namespace and interface with same name documents only the namespace

Đang mở
#5,442 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
42/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
6.5k
Fork
708
Merge trung bình
4 ngày 13 giờ
Pull request đã merge (30 ngày)
62

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/rushstack

Tất cả issue của microsoft/rushstack

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.