microsoft / microsoft/TypeScript
JSDoc comments for async_hooks are confusing/misleading
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.3k
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 132
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xác định JSDoc cho module node:async_hooks được tạo như thế nào và so sánh đầu ra của nó với các trang tài liệu Node.js riêng biệt. Kiểm tra xem cảnh báo được gắn với module hay với từng export riêng lẻ, bao gồm AsyncLocalStorage. Được xem là hoàn tất khi tài liệu được tạo hướng tới TypeScript không còn trình bày cảnh báo của module theo cách gây hiểu nhầm rằng cảnh báo đó áp dụng cho export này.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- node.js, typescript
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100