add the ability to link from the docs to the defining file in the source,
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với scribble/private/manual-proc.rkt và xem xét mã trong pull request 229, đặc biệt là cách defproc xác định các định nghĩa và package của chúng. So sánh phương án thay thế identifier-binding với drracket/check-syntax và find-def-in-file. Công việc được xem là hoàn tất khi tài liệu được tạo ra có các liên kết đến tệp nguồn định nghĩa và, nếu bao gồm phạm vi khó hơn, đến chính định nghĩa đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
it was commented recently that linking to source definitions from the documentation to the defining file in GitHub(lab/etc) would be useful. (note finding the definition of an identifier from DrR or RaMo is already available)
a) defproc code will know the defining file, and the code for the section should know the package that the module is in
alternative: use identifier-binding to get the file (‘Linking to the source file is relatively easy, since that information is in the binding’)
NB see code in https://github.com/racket/scribble/pull/229/files
(harder) to add the ability to link from the docs to the DEFINITION in the defining file in the source,
b) find the line/col with drracket/check-syntax or use find-def-in-file
- Ngôn ngữ chính
- Racket
- Star
- 250
- Fork
- 102
- Merge trung bình
- 11 ngày 9 giờ
- Pull request đã merge (30 ngày)
- 2
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: 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
- Đọ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.
Issue khác của racket/scribble
-
In source strcut*-doc does not convert to defstruct* properly when #:constructor-name is usedĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 74/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
Tất cả issue của racket/scribble
Issue tương tự
-
documentation v0.9.2
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 72/100
khuisman/mcp-gee-sweet#1033 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 2 ngày
-
docs hacktoberfest help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
pacocartones/free-llm-api-hub#347 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
customer-reported question
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Azure/azure-sdk-for-python#49548 · 1 bình luận · 1 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
The-Swarm-Corporation/swarms-framework-docs#302 ·
Maintainer thường phản hồi trong vòng 1 ngày