gh-118469: Document sqlite3.Binary in module constants #136734
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All commit authors signed the Contributor License Agreement. |
Doc/library/sqlite3.rst
Outdated
| .. data:: Binary | ||
|
|
||
| A type object used to describe columns containing :abbr:`BLOB (Binary Large OBject)` data. | ||
| Implemented as an alias for :class:`memoryview`. |
There was a problem hiding this comment.
- Add "this is" to make it a complete sentence.
- 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`. |
There was a problem hiding this comment.
This was not changed and a reason why was not given? I will mark as unresolved.
There was a problem hiding this comment.
I prefer if we leave out implementation details like this from the docs.
Doc/library/sqlite3.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| Binary data can also be stored and retrieved using :class:`bytes` objects |
There was a problem hiding this comment.
This should say that it can be done via bytes-like objects, not just bytes.
There was a problem hiding this comment.
Please link to the bytes-like glossary item.
- Remove redundant second paragraph about DB-API 2.0 specification - Change 'bytes objects' to 'bytes-like objects' for accuracy - Add 'This is the current behavior' to clarify implementation status
c3d89c2 to
617a148
Compare
Typo Fix Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Updated "This is " to make a complete sentence. Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
gh-118469: Add documentation for sqlite3.Binary
Documents sqlite3.Binary as a memoryview alias for handling BLOB data per DB-API 2.0 specification.
Key additions:
Fixes gh-118469
📚 Documentation preview 📚: https://cpython-previews--136734.org.readthedocs.build/