Skip to content

Improve redundant docstring lint message clarity#19043

Merged
harupy merged 3 commits intomasterfrom
copilot/remove-redundant-docstring
Nov 26, 2025
Merged

Improve redundant docstring lint message clarity#19043
harupy merged 3 commits intomasterfrom
copilot/remove-redundant-docstring

Conversation

Copy link
Contributor

Copilot AI commented Nov 26, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19043/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19043/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19043/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Updated the Claude Code lint hook error message to be more actionable. When detecting redundant single-line docstrings in test functions, the linter now explicitly suggests removal rather than just identifying the issue.

Change:

# Before
message=f"Redundant docstring in '{node.name}'"

# After
message=f"Redundant docstring in '{node.name}'. Consider removing it."

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Verified the linter still parses correctly and produces the updated message when detecting redundant docstrings.

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How 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" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)
Original prompt

make this change to suggest removing Redundant docstring

diff --git a/.claude/hooks/lint.py b/.claude/hooks/lint.py
index 4b6d42b180..1a2af373d0 100644
--- a/.claude/hooks/lint.py
+++ b/.claude/hooks/lint.py
@@ -88,7 +88,7 @@ class Visitor(ast.NodeVisitor):
file=self.file_path,
line=docstring_node.lineno,
column=docstring_node.col_offset + 1,

  •                message=f"Redundant docstring in '{node.name}'",
    
  •                message=f"Redundant docstring in '{node.name}'. Consider removing it.",
               )
           )
    

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove redundancy in docstring message Improve redundant docstring lint message clarity Nov 26, 2025
Copilot AI requested a review from harupy November 26, 2025 04:58
@harupy harupy requested a review from serena-ruan November 26, 2025 05:12
@harupy harupy marked this pull request as ready for review November 26, 2025 05:29
@github-actions github-actions bot added area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs. labels Nov 26, 2025
@harupy harupy added this pull request to the merge queue Nov 26, 2025
Merged via the queue into master with commit 6722ce2 Nov 26, 2025
46 of 48 checks passed
@harupy harupy deleted the copilot/remove-redundant-docstring branch November 26, 2025 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants