Repository navigation
Fix docstring Args entries that name a parameter the function does not take - #22733
Merged
Merged
Conversation
darkdi
requested review from
chrisguidry,
desertaxle and
zzstoatzz
as code owners
August 6, 2026 04:33
Merging this PR will not alter performance
Comparing Footnotes
|
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
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.
Twenty-two
Args:entries name a parameter the function does not take. Docstrings only — no signature, no behaviour, no test touched.Twelve are renames where the docstring kept the old name:
WorkPoolClient.send_worker_heartbeat(sync and async)return_idget_worker_idWorkQueueHealthPolicy.evaluate_health_statuslate_runslate_runs_countuse_profileoverride_environment_variableoverride_environment_variablesFlow.deployandFlow.adeployprint_next_steps_messageprint_next_stepsContainerInstancePushProvisioner._log_into_registryregistry_namelogin_serverLocalStoragePathpathcreate_storage_from_sourceurlsourceinclude_objecttypetype_read_eventsfilterevents_filter_construct_block_schema_fields_with_block_referencesblock_schema_with_referencesblock_schemas_with_referencessend_worker_heartbeatalso referred toreturn_ida second time inside its own description, so that went too.The other ten document something that is not an argument:
PrefectEventSubscriber.__init__documentsapi_key, which the constructor does not take — it reads the auth string from settings.Flow.retrydocumentsreturn_state; it takes onlyflow_run.Task.serveandTask.aservedocumenttask_runner; both take no arguments at all, so the wholeArgs:block went.AsyncPostgresConfiguration.engineandAioSqliteConfiguration.engineeach documentconnection_url,echoandtimeout. All three are attributes — the entries even say "Defaults to self.connection_url" — andengine()takes onlyself.Every entry was opened and read against its signature.
ruff checkandruff format --checkpass on all twelve files with the pinnedruff==0.15.19from.pre-commit-config.yaml.