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
finswimmer opened this issue
Aug 15, 2023
· 1 comment
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issue
I've updated docformatter to 1.7.5 and discovered a strange behavior.
Given this minimal example:
asyncdefget_rendered_template(
template_filename: str, parameters: dict[str, Any], jinja_loader: BaseLoader
) ->str:
"""Render the given Template. :param template_filename: name of the template file :param parameters: Parameters passed to the template :param jinja_loader: Loader to find templates path, see https://jinja.palletsprojects.com/en/2.11.x/api/#loaders :return: Returns the rendered Jinja2 Template, which is a valid LaTex file """
...
This is what it looks like after running docformatter:
asyncdefget_rendered_template(
template_filename: str, parameters: dict[str, Any], jinja_loader: BaseLoader
) ->str:
"""Render the given Template. :param template_filename: name of the template file :param parameters: Parameters passed to the template :param jinja_loader: Loader to find templates path, see https://jinja.palletsprojects.com/en/2.11.x/api/#loaders :param template_filename: name of the template file :param parameters: Parameters passed to the template :param jinja_loader: Loader to find templates path, see https://jinja.palletsprojects.com/en/2.11.x/api/#loaders :return: Returns the rendered Jinja2 Template, which is a valid LaTex file """
...
Docformatter is running via pre-commit with this config:
weibullguy
added
P: bug
PEP 257 violation or existing functionality that doesn't work as documented
C: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
and removed
fresh
This is a new issue
labels
Aug 15, 2023
Things that seem to have to be true or this doesn't reproduce:
first line has to have at least two characters, i.e. x. alone stops the duplicate
the text for the parameter has to be long enough for it to split across multiple lines, e.g. when it is :param a: bb s3://cc it fits on one line and there's no duplicate
the URL has to have a "known" URL scheme, e.g. using yy:// stops the duplicate, but http:// has the duplicate
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issue
Hey,
I've updated
docformatter
to 1.7.5 and discovered a strange behavior.Given this minimal example:
This is what it looks like after running
docformatter
:Docformatter is running via
pre-commit
with this config:fin swimmer
The text was updated successfully, but these errors were encountered: