Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RegexFlag parameters not described in most re methods. #119960

Closed
EdStauff opened this issue Jun 3, 2024 · 3 comments
Closed

RegexFlag parameters not described in most re methods. #119960

EdStauff opened this issue Jun 3, 2024 · 3 comments
Labels
docs Documentation in the Doc dir topic-regex

Comments

@EdStauff
Copy link

EdStauff commented Jun 3, 2024

Documentation

In https://docs.python.org/3/library/re.html (also 3.12, 3.13, and 3.14) the flags parameter is defined in the documentation for re.compile(), but not for any other method that takes a flags parameter (search, match, fullmatch, split, findall, finditer, sub, subn).

I expected the documentation for each of those methods to at least specify the type of the flags parameter (presumably re.RegexFlag), with a link to the detailed description under the “Module Contents” section.

Linked PRs

@EdStauff EdStauff added the docs Documentation in the Doc dir label Jun 3, 2024
SweetyAngel added a commit to Forks-collector/cpython that referenced this issue Jun 3, 2024
SweetyAngel added a commit to Forks-collector/cpython that referenced this issue Jun 3, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 19, 2024
…ions (pythonGH-119978)

(cherry picked from commit a86e625)

Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
kumaraditya303 pushed a commit that referenced this issue Jun 19, 2024
…tions (GH-119978) (#120730)

gh-119960: Add information about regex flags in re module functions (GH-119978)
(cherry picked from commit a86e625)

Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
@picnixz
Copy link
Contributor

picnixz commented Jun 21, 2024

@kumaraditya303 it appears that the backport to 3.12 failed (maybe you missed the notification)

@kumaraditya303
Copy link
Contributor

Seems like there was conflict while backporting, can you create the backport manually?

@picnixz
Copy link
Contributor

picnixz commented Jun 23, 2024

I'll try! it's the first time I'm doing it but it shouldn't be that hard (I think).

kumaraditya303 pushed a commit that referenced this issue Jun 23, 2024
…tions (GH-119978) (#120908)

gh-119960: Add information about regex flags in re module functions (#119978)

(cherry picked from commit a86e625)

Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
mrahtz pushed a commit to mrahtz/cpython that referenced this issue Jun 30, 2024
noahbkim pushed a commit to hudson-trading/cpython that referenced this issue Jul 11, 2024
estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-regex
Projects
None yet
Development

No branches or pull requests

4 participants