How to put invisible comment in included file?
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ó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 45/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- ruby
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với ruby/ruby/doc/examples/files.rdoc và kiểm tra cách RDoc xử lý các nỗ lực sử dụng :stopdoc:/:startdoc:, =begin/=end và các dạng chú thích kiểu HTML trong các tệp .rdoc được bao gồm. Xác định xem có cú pháp hiện có nào có thể ẩn cảnh báo mà vẫn giữ lại các ví dụ được bao gồm hay không, hoặc một giải pháp được hỗ trợ nên có hành vi như thế nào; được xem là hoàn tất khi cảnh báo không xuất hiện trong tài liệu được tạo mà không ảnh hưởng đến các ví dụ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Over at ruby/ruby/doc/examples/files.rdoc, we have some code that supports examples in IO, File, and now Pathname.
File files.rdoc is included elsewhere.
I'd like to put into it an invisible warning (comment) about changing the file, since others depend upon it so closely.
I've tried :stopdoc:/:startdoc: and =begin/=end. Even an HTML-style comment like .
Is there some way to make an invisible comment in an included .rdoc file.
- Ngôn ngữ chính
- Ruby
- Star
- 929
- Fork
- 469
- Merge trung bình
- 1 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 19
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc 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.
Issue khác của ruby/rdoc
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationCó thể đã có người làm @OskarEichler đã nhận 37 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
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 85/100
ruby/rdoc#1759 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 68/100
ruby/rdoc#1823 · 5 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Wrong heading levels in generated HTML?Có thể đã có người làm @st0012 đã nhận 2 ngày trước. Đang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
ruby/rdoc#1822 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Maintainer thường phản hồi trong vòng 1 ngày
Issue tương tự
-
Add Catalan (ca) translationĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
eurosky-social/eu-haul#32 ·
-
README configuration examples use the wrong module name and describe removed Bootstrap assetsĐang mởgood first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
benbalter/add-to-org#17 ·
-
good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
benbalter/change_agent#11 ·
-
good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
benbalter/count-org-loc#20 ·
-
good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
benbalter/sitemap-parser#33 ·