I set my PyCharm to use reStructured docstring format, however it does not recognize .. note::
or .. deprecated::
. And by that I mean when you hover over the method which has such annotations, it shows them as plain text. Whereas, in case of :param
and :return:
, a separate section with different font is shown.
Another minor issue is that two consecutive dots are picked by the spelling checker.
Is this a limitation of PyCharm or do I need to use specific configurations?
Setting PyCharm: https://www.jetbrains.com/help/pycharm/settings-tools-python-integrated-tools.html Deprecation Annotation: https://deprecated.readthedocs.io/en/latest/sphinx_deco.html
source https://stackoverflow.com/questions/73354493/note-and-deprecated-annotations-are-not-recognized-by-pycharm
Comments
Post a Comment