Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

gh-94622: Add more references to the sqlite3 types anchor #94623

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
Merged
merged 3 commits into from
Jul 8, 2022
Merged

gh-94622: Add more references to the sqlite3 types anchor #94623

merged 3 commits into from
Jul 8, 2022

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jul 6, 2022 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 6, 2022
@erlend-aasland erlend-aasland linked an issue Jul 6, 2022 that may be closed by this pull request
sqlite3/doc: Use :ref:sqlite3-types instead of spelling the types every time #94622
Closed
@erlend-aasland erlend-aasland added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jul 6, 2022
@erlend-aasland
Copy link
Contributor Author

I'm merging this in a day or two.

AlexWaygood
AlexWaygood reviewed Jul 8, 2022
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Looks good, just one point to consider: from an accessibility point of view, I think it's preferred to have links on complete phrases rather than fragments of phrases — I think that makes it easier for users of screen-readers. So instead of this:

the types :ref:`natively supported by SQLite <sqlite3-types>`

Maybe consider this?

:ref:`the types natively supported by SQLite <sqlite3-types>`

@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jul 8, 2022 •
edited
Loading

Looks good, just one point to consider: from an accessibility point of view, I think it's preferred to have links on complete phrases rather than fragments of phrases — I think that makes it easier for users of screen-readers. [...]

I had a draft that used this:

the :ref:`types natively supported by SQLite <sqlite3-types>`

Would that be acceptable?

UPDATE: I went with your suggestion :)

@erlend-aasland erlend-aasland merged commit e5b841a into python:main Jul 8, 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.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington
Copy link
Contributor

Sorry @erlend-aasland, I had trouble checking out the 3.11 backport branch.
Please backport using cherry_picker on command line.
cherry_picker e5b841a4037d1c2ce3d12a584facf800ae36332a 3.11

@erlend-aasland erlend-aasland deleted the sqlite-doc-types branch July 8, 2022 00:38
@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 e5b841a4037d1c2ce3d12a584facf800ae36332a 3.10

erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jul 8, 2022
@erlend-aasland
[3.11] pythongh-94622: Add more references to the sqlite3 types anchor (
24778c4 
pythonGH-94623)

(cherry picked from commit e5b841a)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 8, 2022
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jul 8, 2022
@erlend-aasland
[3.10] pythongh-94622: Add more references to the sqlite3 types anchor (
135ca3f 
pythonGH-94623).

(cherry picked from commit e5b841a)

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 Jul 8, 2022
@bedevere-bot
Copy link

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

@erlend-aasland erlend-aasland mentioned this pull request Jul 8, 2022
Closed
erlend-aasland added a commit that referenced this pull request Jul 8, 2022
@erlend-aasland
[3.11] gh-94622: Add more references to the sqlite3 types anchor (GH-…
73a1800 
…94623) (#94678)

(cherry picked from commit e5b841a)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
erlend-aasland added a commit that referenced this pull request Jul 8, 2022
@erlend-aasland
[3.10] gh-94622: Add more references to the sqlite3 types anchor (GH-…
691d26a 
…94623). (#94679)

(cherry picked from commit e5b841a)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood left review comments

@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.

sqlite3/doc: Use :ref:sqlite3-types instead of spelling the types every time
4 participants
@erlend-aasland @miss-islington @bedevere-bot @AlexWaygood
Morty Proxy This is a proxified and sanitized view of the page, visit original site.