Skip to content
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.

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

Docs: align the param spec of sqlite3.Connection methods with the implementation #108285

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Aug 22, 2023

  • no parameters of create_aggregate() are positional-only
  • all parameters of create_collation() are positional-only

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

…lementation

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
@erlend-aasland
Copy link
Contributor Author

For the record, here are the clinic inputs for these methods:

/*[clinic input]
_sqlite3.Connection.create_aggregate as pysqlite_connection_create_aggregate
cls: defining_class
/
name: str
n_arg: int
aggregate_class: object
Creates a new aggregate.
[clinic start generated code]*/

/*[clinic input]
_sqlite3.Connection.create_collation as pysqlite_connection_create_collation
cls: defining_class
name: str
callback as callable: object
/
Creates a collation function.
[clinic start generated code]*/

@erlend-aasland
Copy link
Contributor Author

I consider this a non-controversial change; I'll land it as soon as the CI is green.

@erlend-aasland erlend-aasland enabled auto-merge (squash) August 22, 2023 13:15
@erlend-aasland erlend-aasland merged commit 893215a into python:main Aug 22, 2023
22 checks passed
@miss-islington
Copy link
Contributor

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-108287 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Aug 22, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 22, 2023
…lementation (pythonGH-108285)

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a)

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

GH-108288 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Aug 22, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 22, 2023
…lementation (pythonGH-108285)

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
@erlend-aasland erlend-aasland deleted the docs/sqlite-corrections branch August 22, 2023 13:25
erlend-aasland added a commit that referenced this pull request Aug 22, 2023
…the implementation (GH-108285) (#108288)

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Yhg1s pushed a commit that referenced this pull request Aug 22, 2023
…the implementation (GH-108285) (#108287)

Docs: align the param spec of sqlite3.Connection methods with the implementation (GH-108285)

- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants