LuaLS / LuaLS/lua-language-server
Request for ability to skip adding to documentation, i.e. `---@nodoc`
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Lua
- Star
- 4.4k
- Fork
- 442
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.
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 theo dõi cách tài liệu được thu thập khi một tệp tham chiếu đến _G, sau đó xác định nơi có thể nhận diện một marker ---@nodoc. Được xem là hoàn tất khi các symbol cục bộ hoặc không công khai vì lý do khác có thể được loại khỏi tài liệu được tạo ra mà không xóa tài liệu của các symbol công khai; issue không nêu tên tệp hoặc bài kiểm thử nào, vì vậy trước tiên cần xác định các entry point đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- lua
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ 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