Description

AdrianIssott

opened on May 13, 2022

Issue body actions

Documentation

Currently the documentation of sqlite3.create_collation() (https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_collation) says:

Note that the callable will get its parameters as Python bytestrings, which will normally be encoded in UTF-8.

However, as you can see from the discussion on #92742 that's incorrect in python 3 and the callable gets its parameters as Python strs which matches the SQLite docs which says:

Collating functions only matter when comparing string values

Activity

1. AdrianIssott

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on May 13, 2022
2. erlend-aasland

   changed the title [-]The documentation of sqlite3.create_collation() should say the callable gets its parameters as strings[/-] [+]sqlite3: `Connection.create_collation()` documentation inaccuracies[/+] on May 13, 2022
3. erlend-aasland

   added a commit that references this issue on May 13, 2022

   pythongh-92780: Improve sqlite3.Connection.create_collation docs

   b0a5cf4
4. erlend-aasland commented on May 16, 2022

   

   erlend-aasland

   on May 16, 2022

   Contributor

   More actions

   Would you mind reviewing the proposed change, @AdrianIssott?

   Reacted by AdrianIssott
5. erlend-aasland

   added

   topic-sqlite3

   on May 16, 2022
6. erlend-aasland

   closed this as completedin #92790on May 18, 2022
7. erlend-aasland

   added a commit that references this issue on May 18, 2022

   gh-92780: Improve sqlite3.Connection.create_collation docs (#92790)

   7ee19e2
8. miss-islington

   added 3 commits that reference this issue on May 18, 2022

   pythongh-92780: Improve sqlite3.Connection.create_collation docs (pyt…

   ba8993f

   pythongh-92780: Improve sqlite3.Connection.create_collation docs (pyt…

   b9bc99d

   pythongh-92780: Improve sqlite3.Connection.create_collation docs (pyt…

   a695ae6
9. erlend-aasland commented on May 18, 2022

   

   erlend-aasland

   on May 18, 2022

   Contributor

   More actions

   Resolved by:

   • main: gh-92780: Improve sqlite3.Connection.create_collation docs #92790
   • 3.11: [3.11] gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790) #92922
   • 3.10: [3.10] gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790) #92923

   Reacted by Alex Waygood
10. miss-islington

    added 2 commits that reference this issue on May 18, 2022

    gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)

    65ebd92

    gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)

    94e21cf

Issue actions