LuaLS / LuaLS/lua-language-server
How to annotate default arguments to parameters
Đang mở
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ả
Is there a standard way to annotate default arguments? I believe in LDoc you can do:
-- @string[opt='gregorian'] calendar optional calendar
-- @int[opt=0] offset optional offset
I'm currently converting some docs over and couldn't find anything in the wiki.
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 với wiki của dự án và tài liệu chú thích hiện có, sau đó so sánh cú pháp được hỗ trợ với các ví dụ LDoc trong issue. Ghi lại cách chuẩn để biểu diễn các đối số mặc định, hoặc làm rõ rằng cú pháp này không được hỗ trợ, để người dùng chuyển đổi tài liệu có thể xác định chú thích phù hợp.
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ài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- 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
- 42/100