azure-sdk-for-python icon indicating copy to clipboard operation
azure-sdk-for-python copied to clipboard

[pylint] add lint rule for docstring rtype format

Open tjprescott opened this issue 3 years ago • 1 comments

For docstrings, we should have a linter rule to ensure the correct format is used:

wrong:

:rtype: :class:`azure.core.credentials.AccessToken`

right:

:rtype: ~azure.core.credentials.AccessToken

Additionally, APIView for Python will not recognize the first format and will likely yield an error that the docstring and type hint types do not match.

This rule should appy for rtype, type, paramtype and raises

tjprescott avatar Jan 03 '22 23:01 tjprescott

👋@lmazuel is this issue still up for grabs? I'm new to contributing to OSS and would like to give this one a go.

lb-cake avatar Sep 22 '22 12:09 lb-cake

@lb-cake yes, this is certainly up for grabs!

tjprescott avatar Sep 29 '22 22:09 tjprescott

I don't even know what I assigned @lmazuel in the first place.

tjprescott avatar Sep 29 '22 22:09 tjprescott