FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-95273: Align sqlite3 const refs with the devguide by erlend-aasland · Pull Request #95525 · python/cpython · GitHub

/ cpython Public

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

Merged
erlend-aasland merged 2 commits into
python:mainfrom
erlend-aasland:sqlite-reference/none-true-false
Aug 3, 2022
ConversationCommits (2)ChecksFiles changed
Merged

gh-95273: Align sqlite3 const refs with the devguide#95525
erlend-aasland merged 2 commits into
python:mainfrom
erlend-aasland:sqlite-reference/none-true-false

Conversation

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

Copy link
Copy Markdown
Contributor

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 added awaiting core review docs Documentation in the Doc dir skip news labels Aug 1, 2022

erlend-aasland commented Aug 1, 2022

Copy link
Copy Markdown
Contributor Author

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

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

ezio-melotti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM.

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

erlend-aasland commented Aug 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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 commented Aug 3, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

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 approved these changes Aug 3, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

erlend-aasland commented Aug 3, 2022

Copy link
Copy Markdown
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 merged commit 4d02572 into python:main Aug 3, 2022

miss-islington commented Aug 3, 2022

Copy link
Copy Markdown
Contributor

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

erlend-aasland deleted the sqlite-reference/none-true-false branch August 3, 2022 20:21

miss-islington commented Aug 3, 2022

Copy link
Copy Markdown
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 removed the needs backport to 3.11 only security fixes label Aug 3, 2022

bedevere-bot commented Aug 3, 2022

Copy link
Copy Markdown

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
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
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
[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 removed the needs backport to 3.10 only security fixes label Aug 3, 2022

bedevere-bot commented Aug 3, 2022

Copy link
Copy Markdown

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

CAM-Gerlach commented Aug 3, 2022

Copy link
Copy Markdown
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
[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 mentioned this pull request Aug 3, 2022
Closed
5 tasks
erlend-aasland linked an issue Aug 3, 2022 that may be closed by this pull request
Improve the sqlite3 reference #95273
Closed
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

CAM-Gerlach CAM-Gerlach approved these changes
ezio-melotti ezio-melotti approved these changes
berkerpeksag Awaiting requested review from berkerpeksag

Assignees

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

Back | FazBrowse Home | New Git URL