No documentation for sqlite3.Binary

[jonathan-geoseer]

https://docs.python.org/3/library/sqlite3.html - does not have any documentation for sqlite3.Binary() method

Linked PRs

• gh-118469: Document sqlite3 PEP-249 constructors #118975
• gh-118469: Add documentation for sqlite3 PEP-249 constructors #122091
• gh-118469: Document sqlite3.Binary #122343

[erlend-aasland]

Binary() is a part of PEP-249; see https://peps.python.org/pep-0249/#binary

Note that the other PEP-249 constructors are not documented either:

• Date()
• Time()
• Timestamp()
• DateFromTicks()
• TimeFromTicks()
• TimestampFromTicks()

[firatv]

Hello,

A bit of background: I've been learning programming for a few years now. I developed and keep developing projects of my own using mainly shell, C and Python (hosted in gitlab). I want to become an active contributor in the FOSS ecosystem, and I believe Python would be a good place to start. So I searched issues with an 'easy' tag and found this one. I'm familiar with reST and SQL at a beginner level, and I'm learning sqlite3 for my own projects. I set up my development environment as directed in the devguide, built python and its documentation, and ran all the tests.

Now back to the issue at hand: I looked at PEP-249, the documentation for sqlite and its module, and found Lib/sqlite3/dbapi2.py. However, I don't know where to go from here. I'm eager to learn and would be glad if given directions.

Thank you for your time.

[erlend-aasland]

I'm eager to learn and would be glad if given directions.

Great; first, take a look at the devguide section for documentation:

• https://devguide.python.org/documentation/

I also encourage taking a look at our documentation north star, Diátaxis: https://diataxis.fr

The missing documentation should be added to the file Doc/library/sqlite3.rst in the CPython repo. IMO, the missing constructors should be documented under the Module functions header (between line 259 and line 425 in Doc/library/sqlite3.rst). I suggest to add them at the end of that section.

Shout out if you need more info :)

[firatv]

Thank you :) Now I have a clear map in my head and explored most of it. Started implementing. I'll have a pull request by Monday.