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

Jump to bottom

Fix documentation examples of using re with escape sequences #76795

Closed
csabella opened this issue Jan 21, 2018 · 5 comments
Closed

Fix documentation examples of using re with escape sequences #76795

csabella opened this issue Jan 21, 2018 · 5 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@csabella
Copy link
Contributor

BPO 32614
Nosy @terryjreedy, @serhiy-storchaka, @csabella
PRs
  • bpo-32614: Modify re examples to use a raw string to prevent warning #5265
  • [3.7] bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265) #5499
  • [3.6] bpo-32614: Modify re examples to use a raw string to prevent wa… …rning (GH-5265) #5500
    		•

    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 = 'https://github.com/terryjreedy'
closed_at = <Date 2018-02-02.22:38:37.658>
created_at = <Date 2018-01-21.22:47:38.767>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Fix documentation examples of using re with escape sequences'
updated_at = <Date 2018-02-02.22:38:37.657>
user = 'https://github.com/csabella'

    bugs.python.org fields:

    activity = <Date 2018-02-02.22:38:37.657>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2018-02-02.22:38:37.658>
closer = 'terry.reedy'
components = ['Documentation']
creation = <Date 2018-01-21.22:47:38.767>
creator = 'cheryl.sabella'
dependencies = []
files = []
hgrepos = []
issue_num = 32614
keywords = ['patch']
message_count = 5.0
messages = ['310386', '310807', '311516', '311517', '311519']
nosy_count = 4.0
nosy_names = ['terry.reedy', 'docs@python', 'serhiy.storchaka', 'cheryl.sabella']
pr_nums = ['5265', '5499', '5500']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32614'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
    @csabella
    Copy link
    Contributor Author

    If a documentation example would produce a DeprecationWarning for an invalid escape sequence, change the example to use a raw string.

    @csabella csabella added 3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jan 21, 2018
    @terryjreedy
    Copy link
    Member

    Definitely. x.y code, including doc examples, should free of such warnings.

    @terryjreedy terryjreedy added the 3.8 only security fixes label Feb 2, 2018
    @terryjreedy
    Copy link
    Member

    New changeset 6677142 by Terry Jan Reedy (Cheryl Sabella) in branch 'master':
    bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265)
    6677142

    @terryjreedy
    Copy link
    Member

    New changeset c7de1d7 by Terry Jan Reedy (Miss Islington (bot)) in branch '3.7':
    bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265) (bpo-5499)
    c7de1d7

    @terryjreedy
    Copy link
    Member

    New changeset fbf8e82 by Terry Jan Reedy in branch '3.6':
    [3.6] bpo-32614: Modify re examples to use a raw string to prevent wa… …rning (GH-5265) (GH-5500)
    fbf8e82

    @terryjreedy terryjreedy assigned terryjreedy and unassigned docspython Feb 2, 2018
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @terryjreedy @csabella