mypy icon indicating copy to clipboard operation
mypy copied to clipboard

Make sure all error codes are documented

Open JukkaL opened this issue 2 years ago • 4 comments

Sometimes an error code is not documented, which makes it harder for users to figure out why mypy geneated an error. Check if all error codes defined in mypy.errorcodes are mentioned in the documentation (docs/source/error_code_list*.rst) and add documentation for undocumented error codes.

JukkaL avatar Apr 22 '23 13:04 JukkaL

can I handle this issue?

ThanhChinhBK avatar Apr 25 '23 07:04 ThanhChinhBK

@ThanhChinhBK Sure! There's no need to sign up to work on particular issues -- you can just start working.

JukkaL avatar Apr 25 '23 14:04 JukkaL

@JukkaL I created a PR for this issue, could you add reviewer for it

ThanhChinhBK avatar May 30 '23 16:05 ThanhChinhBK

@ThanhChinhBK I could help review it for you but there's merge conflict issue atm

Alex-Wengg avatar Jun 22 '23 15:06 Alex-Wengg

Is this issue still open? I would like to contribute.

Mikil03 avatar Jul 31 '23 06:07 Mikil03

I can handle this, it looks like it still needs to be done. Predicting I'll have it done in a couple of days.

BearNSteen avatar Oct 24 '23 20:10 BearNSteen

It looks like all of the error code documentation has been added, although the missing ones are located in error_code_list2.rst. I have gone through the list of error codes and confirmed all of them are documented between the two separate error code lists. If there are no further codes outside of mypy.errorcodes, this can be closed.

BearNSteen avatar Oct 25 '23 14:10 BearNSteen