Skip to content

gh-111726: Remove some unneeded doctests from sqlite3 docs#117623

Merged
erlend-aasland merged 3 commits into
python:mainfrom
erlend-aasland:sqlite/remove-some-doctests
Apr 8, 2024
Merged

gh-111726: Remove some unneeded doctests from sqlite3 docs#117623
erlend-aasland merged 3 commits into
python:mainfrom
erlend-aasland:sqlite/remove-some-doctests

Conversation

@erlend-aasland

@erlend-aasland erlend-aasland commented Apr 8, 2024

Copy link
Copy Markdown
Contributor
  • Remove the "trace example": using unraisable hooks is not "an
    improved debug experience"
  • Rework the "load extension" doctest as an ordinary code block.
    There is no convenient way to conditionally run this test,
    so don't bother1.

📚 Documentation preview 📚: https://cpython-previews--117623.org.readthedocs.build/

Footnotes

  1. moreover, we should remove the SQL approach from that example; the recommended approach would be to use the Python API.

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

Comment thread Doc/library/sqlite3.rst Outdated
@erlend-aasland

Copy link
Copy Markdown
Contributor Author

Let's go!

@erlend-aasland erlend-aasland enabled auto-merge (squash) April 8, 2024 07:58

@vstinner vstinner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@erlend-aasland erlend-aasland merged commit e338e1a into python:main Apr 8, 2024
@erlend-aasland erlend-aasland deleted the sqlite/remove-some-doctests branch April 8, 2024 08:11
@miss-islington-app

This comment was marked as outdated.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 8, 2024
)

* remove load extension doctest since we cannot skip it conditionally
* remove sys.unraisablehook example; using unraisable hooks is not "an
  improved debug experience"
(cherry picked from commit e338e1a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
@bedevere-app

bedevere-app Bot commented Apr 8, 2024

Copy link
Copy Markdown

GH-117625 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 Apr 8, 2024
erlend-aasland added a commit that referenced this pull request Apr 8, 2024
…117625)

* remove load extension doctest since we cannot skip it conditionally
* remove sys.unraisablehook example; using unraisable hooks is not "an
  improved debug experience"

(cherry picked from commit e338e1a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
* remove load extension doctest since we cannot skip it conditionally
* remove sys.unraisablehook example; using unraisable hooks is not "an
  improved debug experience"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants