github / github/markup

Include code files

Đang mở
#2,084 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Ruby
Star
6k
Fork
3.4k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

#1524

It would be great to have a way to include code files into README.rst. By separating the code to another file, we can do static type checking etc. on our examples to ensure they are always running correctly.

(I don't what the point of adding a stale bot is, if nobody triages the issues here...)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start by reading the referenced issue #1524 and the README.rst examples to determine the intended code-file inclusion behavior. Trace how README.rst is currently processed, then define and test a complete inclusion path whose behavior is clear for separated, statically checked examples.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
ruby
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
Sôi nổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.