docs: function names in the design notes and specs are stale
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ó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức phù hợp với người mới
- 92/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- go
- Lĩnh vực
- documentation
Hướng nghiên cứu
Đọc các vị trí được liệt kê trong design/implementation.md, spec/rename_guarded.fsl và spec/naming_rules.fsl. Cập nhật các tên đã lỗi thời theo những tên thay thế trong issue, giữ nguyên hành vi của các spec. Hoàn tất khi các tham chiếu đó khớp với mã Go và các spec vẫn được xác minh thành công.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
The following names no longer exist in the analyzer's Go code (grep -w):
| Old name | Now | Where it still appears |
|---|---|---|
renameSafe (it survives only in shrink) |
safeToRename |
design/implementation.md, spec/rename_guarded.fsl |
fileScopesBind |
renameBoundByImport |
design/implementation.md, spec/rename_guarded.fsl |
hasUnseenTests |
unseen().all |
design/implementation.md |
directiveFix, startsLine |
directiveInsertionFix, insertionAtLineStart |
design/implementation.md, spec/naming_rules.fsl |
The places are design/implementation.md lines 356, 390, 394, 400, 408 and 472, spec/rename_guarded.fsl lines 6–10 and 66, and spec/naming_rules.fsl line 48.
Suggested fix
Rename them in the docs. Only the spec comments change, so the specs still verify.
- Ngôn ngữ chính
- Go
- Star
- 50
- Fork
- 1
- Merge trung bình
- 57 phút
- Pull request đã merge (30 ngày)
- 135
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 tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
containerd/containerd#14476 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
kind/bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
ome-projects/ome#1242 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
copy design-review mac P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
tosunlab/hisarapp-core#510 ·