re.sub() repl notation explanation is disjointed
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 77.2k
- 分支
- 36k
- PR 合併指標
- PR 指標待擷取
描述
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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
閱讀 issue 中連結的 re.sub() 和 re.Match.expand() 文件部分,然後比較描述字串和可呼叫 repl 引數、轉義字元以及 flags 的段落。完成標準是:repl 表示法的細節和轉義限制表述連貫,並將 pattern/flags 依賴關係放在適當位置;開始前檢查 gh-144891。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100