Repository navigation
Fix docstring Args entries that name a parameter the function does not take - #24925
Merged
Merged
Conversation
…t take Signed-off-by: darkdi <[email protected]>
github-actions
Bot
added
community
Contributor
Install mlflow from this PR
Install mlflow from this PR# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/24925/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/24925/merge#subdirectory=libs/skinnyFor Databricks, use the following command: %sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/24925/mergePR author's recent activityIn the last 14 days, @darkdi opened 24 PRs across 19 repos (showing top 10):
|
github-actions
Bot
added
area/docs
Contributor
There was a problem hiding this comment.
Pull request overview
Corrects stale or invalid parameter names in Python docstrings without changing runtime behavior.
Changes:
- Renames seven outdated or misspelled
Argsentries. - Removes documentation for parameters no longer accepted.
- Updates
_upgrade_db’s parameter description for its SQLAlchemy engine.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tests/store/artifact/test_cli.py |
Corrects the helper argument name. |
mlflow/utils/requirements_utils.py |
Removes the obsolete extras entry. |
mlflow/utils/name_utils.py |
Removes the nonexistent id_length entry. |
mlflow/utils/async_logging/async_artifacts_logging_queue.py |
Corrects the callback parameter name. |
mlflow/tracing/export/mlflow_v3.py |
Removes the obsolete manager entry. |
mlflow/store/tracking/sqlalchemy_store.py |
Removes the obsolete path entry. |
mlflow/store/db/utils.py |
Documents the actual engine parameter. |
mlflow/store/_unity_catalog/registry/uc_oss_rest_store.py |
Corrects the model-name parameter. |
mlflow/sklearn/utils.py |
Removes obsolete fit-argument entries. |
mlflow/projects/databricks.py |
Corrects the profile URI parameter. |
mlflow/models/resources.py |
Corrects the application-name parameter. |
mlflow/models/evaluation/default_evaluator.py |
Removes the nonexistent raw_model entry. |
mlflow/data/meta_dataset.py |
Fixes the schema parameter typo. |
mlflow/ag2/ag2_logger.py |
Removes obsolete patch-function entries. |
harupy
approved these changes
Aug 13, 2026
harupy
approved these changes
Aug 13, 2026
harupy
enabled auto-merge (squash)
August 13, 2026 10:18
Contributor
|
Documentation preview for 56ddc62 is available at: More info
|
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.
Related Issues/PRs
Relates to no existing issue — found by reading
Args:blocks against the signatures they sit above.What changes are proposed in this pull request?
Twenty
Args:entries name a parameter the function does not take. Docstrings only; no signature, no behaviour, no test touched.Seven are renames where the docstring kept the old name:
MetaDatasetschameschema(typo)DatabricksApptable_nameapp_nameDatabricksJobRunnerdatabricks_profiledatabricks_profile_uri_get_temporary_model_version_write_credentials_ossnamemodel_name_upgrade_dburlengineAsyncArtifactsLoggingQueuelogging_funcartifact_logging_func_run_download_artifact_commandcommandargs_upgrade_dbneeded a new description as well as a new name — the old entry described a database URL string, and the argument is a SQLAlchemy engine.The rest document a parameter that no longer exists:
fandspan_nameinAG2Logger._get_patch_function,raw_modelin_extract_predict_fn,fit_argsandfit_kwargsin the threemlflow/sklearn/utils.pyhelpers,pathinSqlAlchemyStore._set_tags,managerin_export_spans_incrementally,extrasin_get_pinned_requirement, andid_lengthin_generate_unique_integer_id, which takes no arguments at all.Two things I noticed but did not touch, since they are a different kind of fix and yours to judge:
DatabricksApp's summary is a verbatim copy ofDatabricksTable's — it still says "Defines a Databricks Unity Catalog (UC) Table". I only corrected the argument name.Steps:prose in the threemlflow/sklearn/utils.pyhelpers still says "Extract X and y_true from fit_args and fit_kwargs", which predates the refactor that madeXandy_truedirect arguments.How is this PR tested?
Every entry was opened and read against its signature.
ruff checkandruff format --checkpass on all fourteen files with the pinnedruff==0.16.0.Does this PR require documentation update?
Does this PR require updating the MLflow Skills repository?
Release Notes
Is this a user-facing change?
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/docs: MLflow documentation pagesHow should the PR be classified in the release notes? Choose one:
rn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionIs this PR a critical bugfix or security fix that should go into the next patch release?