-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Summary
https://docs.astral.sh/ruff/rules/triple-single-quotes/ says
Checks for docstrings that use '''triple single quotes''' instead of """triple double quotes""".
and shares an example for the described case. The explanation and the example is correct for the given case, but it's not the only case D300 handles. It also converts '''docstring'''
to """docstring"""
and 'docstring'
to """docstring"""
.
To sum up, D300 doesn't convert a specific case to triple double quotes but it guarantees that the docstrings are wrapped by triple double quotes. I think the page should be updated to reflect that.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation