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

gh-95273: Align sqlite3 const refs with the devguide #95525

Merged
merged 2 commits into from
Aug 3, 2022
Merged

gh-95273: Align sqlite3 const refs with the devguide #95525

merged 2 commits into from
Aug 3, 2022

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Aug 1, 2022 •
edited by bedevere-bot
Loading

@erlend-aasland erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Aug 1, 2022
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Aug 1, 2022
@erlend-aasland
Copy link
Contributor Author

OTOH, adding ! to the existing refs will definitely look prettier, IMO. I will consider this.

ezio-melotti
ezio-melotti approved these changes Aug 3, 2022
View reviewed changes
Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

As discussed in python/devguide#916 (comment), using ``...`` is preferable to :const:`!...`.

@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Aug 3, 2022 •
edited
Loading

Thanks, Ezio! I forgot to change the parameter list types1; I'll update those before merging.

OTOH, I'm not sure about changing those; maybe best to leave those to the :type directives. Thoughts, @CAM-Gerlach, @ezio-melotti?

Footnotes

  1. Looking at the patch again, I see that I deliberately changed them. ↩

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Aug 3, 2022 •
edited
Loading

OTOH, I'm not sure about changing those; maybe best to leave those to the :type directives. Thoughts, @CAM-Gerlach, @ezio-melotti?

That's what I would do (and have done in my PRs doing this elsewhere) as its simpler, consistent with standard Sphinxdoc usage and the structure makes its semantics unambiguous without the need for additional formatting, particularly since the context is as a type, not a code literal. If we need to customize it, we could monkeypatch the directive or submit an upstream PR instead of manually doing every one.

CAM-Gerlach
CAM-Gerlach approved these changes Aug 3, 2022
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I regexed the doc, built it and and spot-checked the preview, and this LGTM, thanks @erlend-aasland

@erlend-aasland
Copy link
Contributor Author

Yes, you spelled out my thoughts about this, CAM :)

Also, +1 to this:

If we need to customize it, we could monkeypatch the directive or submit an upstream PR instead of manually doing every one.

Thanks for the review, both of you. Highly appreciated! I'll land this.

@erlend-aasland erlend-aasland merged commit 4d02572 into python:main Aug 3, 2022
@miss-islington
Copy link
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@erlend-aasland erlend-aasland deleted the sqlite-reference/none-true-false branch August 3, 2022 20:21
@miss-islington
Copy link
Contributor

Sorry, @erlend-aasland, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 4d02572f8c39b16c83c0883917db4e31efc1048e 3.10

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 3, 2022
@bedevere-bot
Copy link

GH-95616 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 3, 2022
@erlend-aasland @miss-islington
pythongh-95273: Align sqlite3 const doc refs with the devguide recomm…
18eaa5c 
…endations (pythonGH-95525)

(cherry picked from commit 4d02572)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
miss-islington added a commit that referenced this pull request Aug 3, 2022
@miss-islington @erlend-aasland
gh-95273: Align sqlite3 const doc refs with the devguide recommendati…
8d09626 
…ons (GH-95525)

(cherry picked from commit 4d02572)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Aug 3, 2022
@erlend-aasland
[3.10] pythongh-95273: Align sqlite3 const doc refs with the devguide…
3c69446 
… recommendations (pythonGH-95525).

(cherry picked from commit 4d02572)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Aug 3, 2022
@bedevere-bot
Copy link

GH-95618 is a backport of this pull request to the 3.10 branch.

@CAM-Gerlach
Copy link
Member

Yes, you spelled out my thoughts about this, CAM :)

Probably less concisely than you would have, though 😆

erlend-aasland added a commit that referenced this pull request Aug 3, 2022
@erlend-aasland
[3.10] gh-95273: Align sqlite3 const doc refs with the devguide recom…
ac005ea 
…mendations (GH-95525). (#95618)

(cherry picked from commit 4d02572)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
@erlend-aasland erlend-aasland mentioned this pull request Aug 3, 2022
Closed
5 tasks
@erlend-aasland erlend-aasland linked an issue Aug 3, 2022 that may be closed by this pull request
Improve the sqlite3 reference #95273
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ezio-melotti ezio-melotti ezio-melotti approved these changes

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@berkerpeksag berkerpeksag Awaiting requested review from berkerpeksag berkerpeksag is a code owner

Assignees

@erlend-aasland erlend-aasland

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the sqlite3 reference
5 participants
@erlend-aasland @CAM-Gerlach @miss-islington @bedevere-bot @ezio-melotti