Skip to content

Add documentation URL in PyLint formatter#733

Merged
sbrunner merged 1 commit intomasterfrom
doc-url-pylint-output
Mar 12, 2025
Merged

Add documentation URL in PyLint formatter#733
sbrunner merged 1 commit intomasterfrom
doc-url-pylint-output

Conversation

@sbrunner
Copy link
Copy Markdown
Member

@sbrunner sbrunner commented Mar 12, 2025 •
edited
Loading

Description

Make the documentation URL in PyLint formatter

Example of Result:

prospector/formatters/pylint.py:71:4: no-untyped-def(mypy): Function is missing a return type annotation.
                                                            See: https://mypy.rtfd.io/en/stable/_refs.html#code-no-untyped-def
prospector/formatters/pylint.py:71:82: assignment(mypy): Incompatible default for argument "profile" (default has type "str", argument has type "bool").
                                                         See: https://mypy.rtfd.io/en/stable/_refs.html#code-assignment

How Has This Been Tested?

Run it on Prospector code

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

@sbrunner sbrunner force-pushed the doc-url-pylint-output branch from 91d7e01 to 43791b3 Compare March 12, 2025 11:44
@sbrunner sbrunner changed the title Add documentation Url in PyLint output Add documentation URL in PyLint output Mar 12, 2025
@sbrunner sbrunner marked this pull request as ready for review March 12, 2025 11:47
Pierre-Sassoulas
Pierre-Sassoulas reviewed Mar 12, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but the example you gave is mixing mypy url and pylint's name.

@sbrunner sbrunner changed the title Add documentation URL in PyLint output Add documentation URL in PyLint formatter Mar 12, 2025
@sbrunner
Copy link
Copy Markdown
Member Author

sbrunner commented Mar 12, 2025

@Pierre-Sassoulas I modify the PyLint formatter, not the PyLint tool, and in the example I format messages from mypy tool, then it's correct, not?

@Pierre-Sassoulas
Copy link
Copy Markdown
Collaborator

Pierre-Sassoulas commented Mar 12, 2025

Ha right, I misread !

@sbrunner sbrunner merged commit 81560b4 into master Mar 12, 2025
5 checks passed
@Pierre-Sassoulas Pierre-Sassoulas deleted the doc-url-pylint-output branch March 12, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

Assignees

@carlio carlio

@Pierre-Sassoulas Pierre-Sassoulas

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sbrunner @Pierre-Sassoulas @carlio