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

Fix formatting of True and False #82919

Closed
serhiy-storchaka opened this issue Nov 7, 2019 · 9 comments
Closed

Fix formatting of True and False #82919

serhiy-storchaka opened this issue Nov 7, 2019 · 9 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@serhiy-storchaka
Copy link
Member

BPO 38738
Nosy @terryjreedy, @gpshead, @serhiy-storchaka, @vedgar, @maggyero, @miss-islington
PRs
  • bpo-38738: Fix formatting of True and False. #17083
  • [3.8] bpo-38738: Fix formatting of True and False. (GH-17083) #17125
  • [3.7] bpo-38738: Fix formatting of True and False. (GH-17083) #17128
  • bpo-38738: Fix formatting of True and False in the threading documentation #31678
  • [3.10] bpo-38738: Fix formatting of True and False in the threading documentation (GH-31678) #31690
    		•

    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-11-13.15:26:19.009>
created_at = <Date 2019-11-07.19:42:20.480>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Fix formatting of True and False'
updated_at = <Date 2022-03-04.20:38:07.613>
user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2022-03-04.20:38:07.613>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-11-13.15:26:19.009>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2019-11-07.19:42:20.480>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 38738
keywords = ['patch']
message_count = 9.0
messages = ['356210', '356254', '356466', '356473', '356477', '356507', '356535', '414549', '414550']
nosy_count = 7.0
nosy_names = ['terry.reedy', 'gregory.p.smith', 'docs@python', 'serhiy.storchaka', 'veky', 'maggyero', 'miss-islington']
pr_nums = ['17083', '17125', '17128', '31678', '31690']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue38738'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']
    @serhiy-storchaka
    Copy link
    Member Author

    The proposed PR fixes some issues with True and False in the documentation:

    • "Return true/false" is replaced with "Return True/False" if the function actually returns a bool.

    • Fixed formatting of some True and False literals (now in monospace).

    • Replaced "True/False" with "true/false" if it can be not only bool.

    • Replaced some 1/0 with True/False if it corresponds the code.

    @serhiy-storchaka serhiy-storchaka added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Nov 7, 2019
    @serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Nov 7, 2019
    @vedgar
    Copy link
    Mannequin

    vedgar mannequin commented Nov 8, 2019

    Very nice. I aplaud your return to the original Python terminology, of true and false as adjectives, and True and False as names for specific objects. Perlisms such as truthy or that evaluates as True simply make my head spin.

    I wrote one comment, regarding the case where you have the default value mentioned. Otherwise, I think it is a very nice change.

    @serhiy-storchaka
    Copy link
    Member Author

    New changeset 138ccbb by Serhiy Storchaka in branch 'master':
    bpo-38738: Fix formatting of True and False. (GH-17083)
    138ccbb

    @serhiy-storchaka
    Copy link
    Member Author

    New changeset d360346 by Serhiy Storchaka in branch '3.8':
    [3.8] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17125)
    d360346

    @serhiy-storchaka
    Copy link
    Member Author

    New changeset 42b619a by Serhiy Storchaka in branch '3.7':
    [3.7] bpo-38738: Fix formatting of True and False. (GH-17083) (GH-17128)
    42b619a

    @terryjreedy
    Copy link
    Member

    Serhiy, thank you for carrying this through, including the backports.

    Ready to close?

    @serhiy-storchaka
    Copy link
    Member Author

    Thanks Vinay, Kyle and Terry for your review!

    @gpshead
    Copy link
    Member

    gpshead commented Mar 4, 2022

    New changeset 46a116c by Géry Ogam in branch 'main':
    bpo-38738: Fix formatting of True and False in the threading documentation (GH-31678)
    46a116c

    @miss-islington
    Copy link
    Contributor

    New changeset fa69ec8 by Miss Islington (bot) in branch '3.10':
    bpo-38738: Fix formatting of True and False in the threading documentation (GH-31678)
    fa69ec8

    @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 3.9 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
    4 participants
    @gpshead @serhiy-storchaka @terryjreedy @miss-islington