docs: Remove stale client_class arg from SqlClientMixin docstring#2022
Merged
vdusek merged 1 commit intoJul 6, 2026
Merged
Conversation
…cstring The `_safely_open` Args block documented a `client_class` parameter that is not part of the method signature. Remove the stale line so the documented arguments match the actual signature (id, name, alias, storage_client, metadata_model, extra_metadata_fields), consistent with the sibling `_open` method's docstring.
vdusek
changed the title
vdusek
approved these changes
Jul 6, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
SqlClientMixin._safely_open(src/crawlee/storage_clients/_sql/_client_mixin.py)had a Google-style Args block that documented a
client_classparameter which isnot part of the method signature. The method's keyword-only parameters are
id,name,alias,storage_client,metadata_model, andextra_metadata_fields,so the
client_classline was stale documentation for an argument that does notexist.
This removes that single line so the documented arguments match the actual
signature, consistent with the sibling
_openmethod whose Args block alreadymatches its signature. No code behavior changes.
Issues
Testing
doc fixes are handled here).
uv run poe lint(ruff format check + ruff check): clean.uv run poe type-check(ty): no new diagnostics from this change; the onlydiagnostics are pre-existing
unresolved-importwarnings for the optional,uninstalled
pydantic_aidependency, and none reference the touched file.uv run pytest tests/unit/storage_clients/_sql/: 34 passed (these exercise the_safely_openopen paths for dataset / KVS / request-queue / storage clients).Checklist