You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Whatever the convention I select for pydocstring (D212: start on the first line or D213: start on second line) I should get the same results when building documentation with Sphinx. I found out that if I use D212 (default behaviour for ruff) in combination with deprecated, then the indetation is shifted and the parameters are interpreted as quotes.
I created a small repository that you can launch by executing "nox" from the root. that shows the behavior.
This works as expected:
@versionadded(version="0.0.1", reason="because")deftiti (a, b) ->None:
""" A one line short description pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum pim pam poum Args: a: the first parameter b: a second parameter Returns: nothing """return
Expected Behavior
Whatever the convention I select for pydocstring (D212: start on the first line or D213: start on second line) I should get the same results when building documentation with Sphinx. I found out that if I use D212 (default behaviour for ruff) in combination with
deprecated
, then the indetation is shifted and the parameters are interpreted as quotes.I created a small repository that you can launch by executing "nox" from the root. that shows the behavior.
This works as expected:
but this doesn't:
see this RDT page for the result.
The text was updated successfully, but these errors were encountered: