re.sub() repl notation explanation is disjointed
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 35.9k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Documentation
[I'm sending a PR proposing multiple changes, trying to list here the more "objective" issues and leaving my subjective choices to the PR...]
re.sub, also briefly in re.Match.expand.
Information on how repl argument is processed is split between the first (" repl can be a string or a function; if it is a string ...") and second-to-last paragraphs ("In string-type repl arguments, in addition ..."), in a way that is somewhat arbitrary/illogical, and some important subtleties are omitted:
- "Unknown escapes" are discussed in first paragraph after mentioning only regular python escapes like \n, before sentence on
\6and far before introducing\g<...>in late paragraph! \6is introduced early but details of how\20is parsed is added late in\gdiscussion. Ambiguities vs. octal notation (\02,\200,\2000) are not mentioned. Reader may guess this is like\2vs. octal in regex notation.- The wording suggests "all escapes" supported in Python string literals are processed. Not so —
\x\u\U\Naren't, UNLIKE regex notation. This bears on "unknown escape" handling.
Additionally, the final paragraph documenting flags (added in #119960) comes far after "The pattern may be a string or a Pattern", but actually flags param is only allowed when pattern pattern is a string, which can be best explained by moving these together.
[However, that dependence is worth mentioning in several other functions, so perhaps that deserves separate issue/PR?]
Linked PRs
- gh-144891
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.
Hướng nghiên cứu
Đọc các phần tài liệu về re.sub() và re.Match.expand() được liên kết trong issue, sau đó so sánh các đoạn mô tả các đối số repl dạng string và callable, escapes và flags. Hoàn thành có nghĩa là các chi tiết về ký hiệu repl và những hạn chế của escapes được trình bày mạch lạc, với sự phụ thuộc vào pattern/flags được đặt ở vị trí phù hợp; hãy kiểm tra gh-144891 trước khi bắt đầu.
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
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 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
- 25/100