gh-95273: Align sqlite3 const refs with the devguide

[erlend-aasland]

• Issue: Improve the sqlite3 reference #95273

[erlend-aasland]

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

[ezio-melotti]

LGTM.

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

[erlend-aasland]

Thanks, Ezio! I forgot to change the parameter list types¹; 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]

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]

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

[erlend-aasland]

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.

[miss-islington]

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

[miss-islington]

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]

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

[bedevere-bot]

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

[CAM-Gerlach]

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

Probably less concisely than you would have, though 😆