Docstring style in Pycharm
gurland opened this issue · 1 comments
I tried to run this plugin with:
[pydocstyle]
convention = "google"
but PyCharm is suggesting using Sphinx documentation, generating boilerplate like :param:
and :return:
I am unsure whether it's bug or not
Can you provide some additional context on this? Is the config snippet part of a Ruff config file (ruff.toml
or .ruff.toml
)?
but PyCharm is suggesting using Sphinx documentation, generating boilerplate like
:param:
and:return:
I think this might be unrelated to Ruff as PyCharm won't be using the Ruff config to determine which style of documentation to use to generate the boilerplate code. You might need to configure this in the PyCharm settings itself. I think this page might help: https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html
I hope this helps but feel free to ask any other questions :)