Skip to content

gh-118469: Document sqlite3.Binary in module constants #136734

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-118469: Document sqlite3.Binary in module constants #136734

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
617a148
gh-118469: Document sqlite3.Binary in module constants
killerdevildog Jul 17, 2025
1ab40bb
Update Doc/library/sqlite3.rst
killerdevildog Jul 17, 2025
a9b10b0
Update Doc/library/sqlite3.rst
killerdevildog Jul 17, 2025
3d5e91b
Merge branch 'main' into doc-improvements-sqlite3-binary
killerdevildog Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,16 @@ Module constants

The ``named`` DB-API parameter style is also supported.

.. data:: Binary

A type object used to describe columns containing :abbr:`BLOB (Binary Large Object)` data.
Implemented as an alias for :class:`memoryview`.
Copy link
Member

Choose a reason for hiding this comment

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

  1. Add "this is" to make it a complete sentence.
  2. Mention that is the current behavior; we can change it in the future.
Suggested change
Implemented as an alias for :class:`memoryview`.
This is currently implemented as an alias for :class:`memoryview`.

Copy link
Member

Choose a reason for hiding this comment

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

This was not changed and a reason why was not given? I will mark as unresolved.

Copy link
Contributor

Choose a reason for hiding this comment

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

I prefer if we leave out implementation details like this from the docs.


.. note::

Binary data can also be stored and retrieved using bytes-like objects
directly without using :data:`!Binary`. This is the current behavior.

.. data:: sqlite_version

Version number of the runtime SQLite library as a :class:`string <str>`.
Expand Down
Loading