python / python/blurb

Preserve indentation in multi-line list entry

Đang mở
#11 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
22
Fork
13
Merge trung bình
4 giờ 3 phút
Pull request đã merge (30 ngày)
5

Mô tả

I would like to put this in a NEWS entry:

The following `threading` methods are now deprecated and should be replaced:

- `threading.activeCount` => :func:`threading.active_count`

- `threading.Condition.notifyAll` =>
    :meth:`threading.Condition.notify_all`

But when blurb generates the NEWS file, it produces:

- bpo-43723: The following `threading` methods are now deprecated and should
  be replaced:

  - `threading.activeCount` => :func:`threading.active_count`

  - `threading.Condition.notifyAll` =>
  :meth:`threading.Condition.notify_all`

Which is invalid rst, because the second line of the list is not indented enough.

It's because blurb uses textwrap.wrap to reflow the text, and that function eats any leading space in the line. Fixing this might require doing something more RST-aware.

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách xác định nơi blurb sử dụng Python's textwrap.wrap và tái hiện vấn đề với mục NEWS được hiển thị ở đây. Theo dõi cách các mục danh sách nhiều dòng được định dạng lại, sau đó xác minh rằng đầu ra được tạo ra vẫn giữ nguyên thụt lề cần thiết cho reStructuredText hợp lệ.

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

Đánh giá

Công nghệ
python
Lĩnh vực
cli
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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
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.