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
gh-95273: Align sqlite3 const refs with the devguide #95525
gh-95273: Align sqlite3 const refs with the devguide #95525
Conversation
erlend-aasland
commented
Aug 1, 2022
•
edited by bedevere-bot
edited by bedevere-bot
- Issue: gh-95273
|
OTOH, adding |
LGTM.
As discussed in python/devguide#916 (comment), using ``...`` is preferable to :const:`!...`.
|
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 Footnotes
|
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. |
I regexed the doc, built it and and spot-checked the preview, and this LGTM, thanks @erlend-aasland
|
Yes, you spelled out my thoughts about this, CAM :) Also, +1 to this:
Thanks for the review, both of you. Highly appreciated! I'll land this. |
|
Thanks @erlend-aasland for the PR |
|
Sorry, @erlend-aasland, I could not cleanly backport this to |
|
GH-95616 is a backport of this pull request to the 3.11 branch. |
…endations (pythonGH-95525) (cherry picked from commit 4d02572) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
… recommendations (pythonGH-95525). (cherry picked from commit 4d02572) Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
|
GH-95618 is a backport of this pull request to the 3.10 branch. |
Probably less concisely than you would have, though |