Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Link to the error's documentation #57

Closed
Avasam opened this issue Jun 13, 2023 · 2 comments · Fixed by #58
Closed

Feature request: Link to the error's documentation #57

Avasam opened this issue Jun 13, 2023 · 2 comments · Fixed by #58
Assignees
Labels
author-verification-requested Issues potentially verifiable by issue author feature-request Request for new features or functionality good first issue Good for newcomers needs PR
Milestone

Comments

@Avasam
Copy link
Contributor

Avasam commented Jun 13, 2023

I would like for the error info popup to also link to the appropriate error code documentation. For example no-untyped-def would link to https://mypy.readthedocs.io/en/stable/error_code_list2.html#check-that-every-function-has-an-annotation-no-untyped-def . Similarly to how ESLint and Pylance do it:
image
image

I found that it is an extremely powerful tool for learning and help devs understand the errors. Especially newer developers who are less keen to go dig up documentation they don't even know if it exists.

@karthiknadig karthiknadig added feature-request Request for new features or functionality needs community feedback and removed triage-needed labels Jun 13, 2023
@karthiknadig karthiknadig self-assigned this Jun 13, 2023
@karthiknadig
Copy link
Member

Thanks for the feature request! We are going to give the community time to provide upvotes on the opening comment to gauge general interest in this idea. If there's enough upvotes then we will consider this feature request in our future planning. If there's unfortunately not enough upvotes then we will close this issue.

@karthiknadig
Copy link
Member

@Avasam We are open to take PR for this feature request. Here is a similar feature implemented for our pylint extension microsoft/vscode-pylint#298 . This repo has the same structure as the pylint extension.

Here is our contributing guide for this repo to set it up: https://github.com/microsoft/vscode-mypy/wiki/Contributing-Guide

@karthiknadig karthiknadig added this to the June 2023 milestone Jun 14, 2023
@karthiknadig karthiknadig added the author-verification-requested Issues potentially verifiable by issue author label Jun 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author-verification-requested Issues potentially verifiable by issue author feature-request Request for new features or functionality good first issue Good for newcomers needs PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants