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

Misformated manpage: --check-hash-based-pycs ´default´|´always´|´never´ #80264

Closed
hroncok mannequin opened this issue Feb 22, 2019 · 5 comments
Closed

Misformated manpage: --check-hash-based-pycs ´default´|´always´|´never´ #80264

hroncok mannequin opened this issue Feb 22, 2019 · 5 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir

Comments

@hroncok
Copy link
Mannequin

hroncok mannequin commented Feb 22, 2019

BPO 36083
Nosy @benjaminp, @hroncok, @csabella, @miss-islington
PRs
  • bpo-36083: Fix formatting of the manpage Synopsis #12017
  • [3.7] closes bpo-36083: Fix formatting of the manpage Synopsis. (GH-12017) #12025
    		•

    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 = <Date 2019-02-25.00:50:33.308>
created_at = <Date 2019-02-22.18:42:43.736>
labels = ['3.7', '3.8', 'docs']
title = 'Misformated manpage: --check-hash-based-pycs \xc2\xb4default\xc2\xb4|\xc2\xb4always\xc2\xb4|\xc2\xb4never\xc2\xb4'
updated_at = <Date 2019-02-25.00:56:15.974>
user = 'https://github.com/hroncok'

    bugs.python.org fields:

    activity = <Date 2019-02-25.00:56:15.974>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-02-25.00:50:33.308>
closer = 'benjamin.peterson'
components = ['Documentation']
creation = <Date 2019-02-22.18:42:43.736>
creator = 'hroncok'
dependencies = []
files = []
hgrepos = []
issue_num = 36083
keywords = ['patch']
message_count = 5.0
messages = ['336342', '336403', '336410', '336494', '336495']
nosy_count = 5.0
nosy_names = ['benjamin.peterson', 'docs@python', 'hroncok', 'cheryl.sabella', 'miss-islington']
pr_nums = ['12017', '12025']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue36083'
versions = ['Python 3.7', 'Python 3.8']
    @hroncok
    Copy link
    Mannequin Author

    hroncok mannequin commented Feb 22, 2019

    man python3.7 or man python3.8 says this in synopsis:

       python [ -B ] [ -b ] [ -d ] [ -E ] [ -h ] [ -i ] [ -I ]
          [ -m module-name ] [ -q ] [ -O ] [ -OO ] [ -s ] [ -S ] [ -u ]
          [ -v ] [ -V ] [ -W argument ] [ -x ] [ [ -X option ] -?  ]
          [ --check-hash-based-pycs ´default´|´always´|´never´ ]
          [ -c command | script | - ] [ arguments ]

    Some words are bold, some are underlined. However the ´default´|´always´|´never´ bit after --check-hash-based-pycs is misformated. The backticks should not be there, they should be underline instead.

    The source literally has:

       [

    .B \--check-hash-based-pycs
    \'default\'|\'always\'|\'never\'
    ]

    since the original implementation of PEP-552 in 42aa93b

    I think it should be replaced with:

       [

    .B \--check-hash-based-pycs
    .I default|always|never
    ]

    Shall I send a PR?

    @hroncok hroncok mannequin added 3.7 (EOL) end of life 3.8 only security fixes labels Feb 22, 2019
    @hroncok hroncok mannequin assigned docspython Feb 22, 2019
    @hroncok hroncok mannequin added the docs Documentation in the Doc dir label Feb 22, 2019
    @csabella
    Copy link
    Contributor

    Thanks for the report, Miro! Adding Benjamin Peterson to the nosy, since that was his commit. I'd wait until he comments before making a PR.

    @benjaminp
    Copy link
    Contributor

    A PR would be welcome.

    On Sat, Feb 23, 2019, at 12:08, Cheryl Sabella wrote:

    Cheryl Sabella <cheryl.sabella@gmail.com> added the comment:

    Thanks for the report, Miro! Adding Benjamin Peterson to the nosy,
    since that was his commit. I'd wait until he comments before making a
    PR.

    ----------
    nosy: +benjamin.peterson, cheryl.sabella

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

    @benjaminp
    Copy link
    Contributor

    New changeset 16323cb by Benjamin Peterson (Miro Hrončok) in branch 'master':
    closes bpo-36083: Fix formatting of the manpage Synopsis. (GH-12017)
    16323cb

    @miss-islington
    Copy link
    Contributor

    New changeset ca5e6aa by Miss Islington (bot) in branch '3.7':
    closes bpo-36083: Fix formatting of the manpage Synopsis. (GH-12017)
    ca5e6aa

    @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
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @benjaminp @csabella @miss-islington