Sitelet https://web.archive.org/web/20240502113550/https://github.com/python/cpython/issues/76839
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.

Sign up for GitHub

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

Jump to bottom

Metacharacter (\) documentation suggestion #76839

Closed
kdraeder mannequin opened this issue Jan 25, 2018 · 13 comments
Closed

Metacharacter (\) documentation suggestion #76839

kdraeder mannequin opened this issue Jan 25, 2018 · 13 comments
Labels
3.11 only security fixes docs Documentation in the Doc dir easy topic-regex type-feature A feature request or enhancement

Comments

@kdraeder
Copy link
Mannequin

kdraeder mannequin commented Jan 25, 2018

BPO 32658
Nosy @JelleZijlstra, @miss-islington, @jdevries3133, @MaxwellDupre, @slateny
PRs
  • bpo-32658: Add Metacharacter (except \) are not active inside classes Regexpr HOWTO (GH-32230) #32230
  • [3.9] bpo-32658: Regex docs: Fix metacharacter reference (GH-32230) #32322
  • [3.10] bpo-32658: Regex docs: Fix metacharacter reference (GH-32230) #32323
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = None
created_at = <Date 2018-01-25.00:01:01.271>
labels = ['easy', '3.11', 'type-feature', 'docs']
title = 'Metacharacter (\\) documentation suggestion'
updated_at = <Date 2022-04-05.03:11:44.145>
user = 'https://bugs.python.org/kdraeder'

    bugs.python.org fields:

    activity = <Date 2022-04-05.03:11:44.145>
actor = 'miss-islington'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-01-25.00:01:01.271>
creator = 'kdraeder'
dependencies = []
files = []
hgrepos = []
issue_num = 32658
keywords = ['patch', 'easy', 'newcomer friendly']
message_count = 12.0
messages = ['310647', '411165', '411195', '416241', '416250', '416311', '416445', '416486', '416725', '416726', '416733', '416734']
nosy_count = 7.0
nosy_names = ['docs@python', 'JelleZijlstra', 'kdraeder', 'miss-islington', 'jack__d', 'mikecmcleod', 'slateny']
pr_nums = ['32230', '32322', '32323']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32658'
versions = ['Python 3.11']
    @kdraeder
    Copy link
    Mannequin Author

    kdraeder mannequin commented Jan 25, 2018

    I've found the Regular Expression HOWTO to be very helpful
    (https://docs.python.org/3/howto/regex.html?highlight=regular%20expressions).
    One inconsistency I noticed is that the intro to metacharacters says
    "Metacharacters are not active inside classes. "
    But farther down we learn that a class can be constructed using \s: [\s,.],
    which is "all white space characters , and ."
    It's not the 4 characters "\ s , and ."
    So I think the first statement would be clearer as
    "Metacharacters (except \) are not active inside classes. "

    @kdraeder kdraeder mannequin assigned docspython Jan 25, 2018
    @kdraeder kdraeder mannequin added the docs Documentation in the Doc dir label Jan 25, 2018
    @iritkatriel iritkatriel added easy 3.11 only security fixes labels Nov 21, 2021
    @AlexWaygood AlexWaygood added the type-feature A feature request or enhancement label Nov 21, 2021
    @MaxwellDupre
    Copy link
    Mannequin

    MaxwellDupre mannequin commented Jan 21, 2022

    I would like to help with this issue. Is that acceptable?

    @kdraeder
    Copy link
    Mannequin Author

    kdraeder mannequin commented Jan 21, 2022

    Sure! Thanks for paying attention to my suggestion.
    Kevin

    On Fri, Jan 21, 2022 at 10:42 AM mike mcleod <report@bugs.python.org> wrote:

    mike mcleod <mikecmcleod@gmail.com> added the comment:

    I would like to help with this issue. Is that acceptable?

    ----------
    nosy: +mikecmcleod

    Python tracker <report@bugs.python.org>
    <https://bugs.python.org/issue32658\>

    @slateny
    Copy link
    Contributor

    slateny commented Mar 29, 2022

    Mike, are you still working on this issue?

    @MaxwellDupre
    Copy link
    Mannequin

    MaxwellDupre mannequin commented Mar 29, 2022

    Sorry, forgot this one. Would you like me to move this forward? Or do you want to take it? I don't mind either way.

    @slateny
    Copy link
    Contributor

    slateny commented Mar 30, 2022

    Feel free, it's all yours

    @MaxwellDupre
    Copy link
    Mannequin

    MaxwellDupre mannequin commented Mar 31, 2022

    After sync'ing to upstream/main and then running make html I get: ...
    checking consistency... done
    preparing documents... failed

    Warning, treated as error:
    unsupported theme option 'license_url' given
    make: *** [Makefile:53: build] Error 2

    I cant see anything from googling the error above.
    This is before I have made any changes.

    @jdevries3133
    Copy link
    Mannequin

    jdevries3133 mannequin commented Apr 1, 2022

    Did you run make venv to setup your virtual environment? Sphynx themes are usually pip dependencies, so if you're getting a "missing theme" error, it sounds like your virtual environment is not setup right.

    @JelleZijlstra
    Copy link
    Member

    New changeset 43571a3 by Mike cm in branch 'main':
    bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
    43571a3

    @JelleZijlstra
    Copy link
    Member

    Thanks for the patch!

    @miss-islington
    Copy link
    Contributor

    New changeset d95e072 by Miss Islington (bot) in branch '3.10':
    bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
    d95e072

    @miss-islington
    Copy link
    Contributor

    New changeset 31c9e35 by Miss Islington (bot) in branch '3.9':
    bpo-32658: Regex docs: Fix metacharacter reference (GH-32230)
    31c9e35

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    @AlexWaygood
    Copy link
    Member

    I think this is now fixed, so I'm closing the issue.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.11 only security fixes docs Documentation in the Doc dir easy topic-regex type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @JelleZijlstra @iritkatriel @miss-islington @slateny @AlexWaygood