Skip to content

Docs: align sqlite3 docs with versionadded/versionchanged recommendations #114400

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 2 commits into from
Jan 21, 2024
Merged

Docs: align sqlite3 docs with versionadded/versionchanged recommendations #114400

merged 2 commits into from
Jan 21, 2024

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 21, 2024 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added awaiting core review docs Documentation in the Doc dir labels Jan 21, 2024
CAM-Gerlach
CAM-Gerlach reviewed Jan 21, 2024
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM overall, thanks.

To note, auditing the rest of the annotations, there's also a related issue: On lines 356 766, 825, 994, 1013 and 1041 the versionchanged:: 3.13 for the keyword argument deprecations should probably be a deprecated-removed:: 3.13 3.15, since deprecations should and generally are documented as such (despite the imprecision of not currently being able to distinguish deprecations.removals of objects versus parameters and behaviors, which I'm working on fixing).

You might want to fix that either here, or in another PR.

CAM-Gerlach
CAM-Gerlach reviewed Jan 21, 2024
View reviewed changes
@erlend-aasland
Copy link
Contributor Author

erlend-aasland commented Jan 21, 2024 •
edited
Loading

To note, auditing the rest of the annotations, there's also a related issue: On lines 356 766, 825, 994, 1013 and 1041 the versionchanged:: 3.13 for the keyword argument deprecations should probably be a deprecated-removed:: 3.13 3.15, since deprecations should and generally are documented as such (despite the imprecision of not currently being able to distinguish deprecations.removals of objects versus parameters and behaviors, which I'm working on fixing).

I'm not so sure about these. IMO, we're talking about behaviour changes (params becoming positional-only or keyword-only), not removals of parameters.

IOW, I'd like to pass on this suggestion for this PR. We can amend them in a follow-up PR if needed.

@erlend-aasland @CAM-Gerlach
Update Doc/library/sqlite3.rst
704c492 
Co-authored-by: C.A.M. Gerlach <[email protected]>
@erlend-aasland erlend-aasland enabled auto-merge (squash) January 21, 2024 19:50
@erlend-aasland erlend-aasland merged commit 3360301 into python:main Jan 21, 2024
@erlend-aasland erlend-aasland deleted the docs/sqlite/versionchanged branch January 21, 2024 19:54
@miss-islington-app

This comment was marked as outdated.

Sign in to view
@miss-islington-app

This comment was marked as outdated.

Sign in to view
@miss-islington-app

This comment was marked as outdated.

Sign in to view
@bedevere-app
Copy link

bedevere-app bot commented Jan 21, 2024

GH-114402 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jan 21, 2024
erlend-aasland added a commit to erlend-aasland/cpython that referenced this pull request Jan 21, 2024
@erlend-aasland
[3.12] Docs: align sqlite3 docs with versionadded/versionchanged reco…
d08c3b9 
…mmendations (python#114400)

(cherry picked from commit 3360301)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
@bedevere-app
Copy link

bedevere-app bot commented Jan 21, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Jan 21, 2024
erlend-aasland added a commit that referenced this pull request Jan 21, 2024
@erlend-aasland
[3.12] Docs: align sqlite3 docs with versionadded/versionchanged reco…
5183a5d 
…mmendations (#114400) (#114402)

(cherry picked from commit 3360301)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
erlend-aasland added a commit that referenced this pull request Jan 21, 2024
@erlend-aasland
[3.11] Docs: align sqlite3 docs with versionadded/versionchanged reco…
9f164ab 
…mmendations (#114400) (#114403)

(cherry picked from commit 3360301)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
kulikjak pushed a commit to kulikjak/cpython that referenced this pull request Jan 22, 2024
@erlend-aasland @kulikjak
Docs: align sqlite3 docs with versionadded/versionchanged recommendat…
d409004 
…ions (python#114400)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
@CAM-Gerlach
Copy link
Member

I'm not so sure about these. IMO, we're talking about behaviour changes (params becoming positional-only or keyword-only), not removals of parameters.

Right, thought just to note, elsewhere deprecated-removed is routinely used for behavior deprecations too, as there isn't currently is a finer grained directive to distinguish deprecations of entire objects/APIs from deprecations of specific behaviors/functionality of the object (which is something I'm working on enhancing our existing custom deprecated-removed directive to allow).

IOW, I'd like to pass on this suggestion for this PR. We can amend them in a follow-up PR if needed.

Yup, entirely fair of course 👍

aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@erlend-aasland @aisk
Docs: align sqlite3 docs with versionadded/versionchanged recommendat…
1b51498 
…ions (python#114400)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@erlend-aasland @Glyphack
Docs: align sqlite3 docs with versionadded/versionchanged recommendat…
82d0157 
…ions (python#114400)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach 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 issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@erlend-aasland @CAM-Gerlach