-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
Doc: Fix ref warnings for Point class in sqlite3 & make consistant #96095
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
Doc: Fix ref warnings for Point class in sqlite3 & make consistant #96095
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any difference in the rendering of the output or other reasons that make :class:`!Point`
preferable to just ``Point``
?
If you consider it simply a variable, then ``Point``
would be appropriate, and makes the source easier to read/write.
Actually, it does render differently:
vs. I don't have a strong preference; I could see an argument for it either way. On one hand, @ezio-melotti @erlend-aasland what do you think? We can go with whatever you agree is best here, and presumably document that for the future at some point along with the rest of python/docs-community#52 |
In this case I prefer |
Since we already use (broken) |
Thanks @CAM-Gerlach for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11. |
GH-96113 is a backport of this pull request to the 3.11 branch. |
GH-96114 is a backport of this pull request to the 3.10 branch. |
…GH-96095) (cherry picked from commit 303ef09) Co-authored-by: C.A.M. Gerlach <[email protected]>
…GH-96095) (cherry picked from commit 303ef09) Co-authored-by: C.A.M. Gerlach <[email protected]>
(cherry picked from commit 303ef09) Co-authored-by: C.A.M. Gerlach <[email protected]>
(cherry picked from commit 303ef09) Co-authored-by: C.A.M. Gerlach <[email protected]>
After all of @erlend-aasland 's work in the
sqlite3
module docs, there are only a few broken references (causing warnings) left. Following our guidance established earlier, this fixes:class:
references to the examplePoint
class to be non-resolved (!
), and also converts aliteral
reference to a non-resolved:class:
for syntactic, semantic and formatting consistency.This leaves only warnings about the missing
SQLITE_*
module-level constants that are currently not explicitly documented (likesqlite.PrepareProtocol
), but I'll open a separate issue for that, since the fix is somewhat less trivial.