Reduce clint error message verbosity by consolidating README instructions#19155
Merged
Reduce clint error message verbosity by consolidating README instructions#19155
Conversation
Move "See dev/clint/README.md..." message from individual errors to after the "Found N errors" summary. This makes the output much more concise when multiple errors are present. Before: file.py:2:1: MLF0003: Error message See dev/clint/README.md for instructions on ignoring this rule (rule-name). file.py:12:1: MLF0003: Error message See dev/clint/README.md for instructions on ignoring this rule (rule-name). Found 2 errors After: file.py:2:1: MLF0003: Error message file.py:12:1: MLF0003: Error message Found 2 errors See dev/clint/README.md for instructions on ignoring these rules. Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
reviewed
Dec 2, 2025
Updated the README reference message to use "this rule" for single errors and "these rules" for multiple errors, improving grammar consistency. Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update clint error message format
Reduce clint error message verbosity by consolidating README instructions
Dec 2, 2025
Combined the two separate print statements into a single print statement with a newline separator, making the code more concise. Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
approved these changes
Dec 2, 2025
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
#xxx
What changes are proposed in this pull request?
The
clintlinter appended"See dev/clint/README.md for instructions on ignoring this rule (<rule_name>)."after each error, creating excessive verbosity with multiple violations.Changes:
Violation.__str__()output inlinter.py__init__.pywith proper singular/plural grammarprint()statement for cleaner codeBefore:
After:
How is this PR tested?
All 189 clint tests pass. Manually verified output for single error, multiple errors, and no errors cases.
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
Clint linter now shows README instructions once after the error summary instead of repeating them on each error line, reducing output verbosity.
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/tracking: Tracking Service, tracking client APIs, autologgingarea/models: MLmodel format, model serialization/deserialization, flavorsarea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflowsarea/gateway: MLflow AI Gateway client APIs, server, and third-party integrationsarea/prompts: MLflow prompt engineering features, prompt templates, and prompt managementarea/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionalityarea/projects: MLproject format, project running backendsarea/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/build: Build and test infrastructure for MLflowarea/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" sectionrn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notesShould this PR be included in the next patch release?
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.