docs(rules): expand D300 description to include single quotes

Author: Jkhall81

crates/ruff_linter/src/rules/pydocstyle/rules/triple_quotes.rs

@@ -7,8 +7,8 @@ use crate::docstrings::Docstring;
 use crate::{Edit, Fix, FixAvailability, Violation};
 
 /// ## What it does
-/// Checks for docstrings that use `'''triple single quotes'''` instead of
-/// `"""triple double quotes"""`.
+/// Checks for docstrings that use single quotes (`'`) or triple single quotes (`'''`)
+/// instead of triple double quotes (`"""`).
 ///
 /// ## Why is this bad?
 /// [PEP 257](https://peps.python.org/pep-0257/#what-is-a-docstring) recommends
@@ -19,12 +19,18 @@ use crate::{Edit, Fix, FixAvailability, Violation};
 /// ```python
 /// def kos_root():
 ///     '''Return the pathname of the KOS root directory.'''
+///
+/// def kos_branch():
+///     'Return the branch name.'
 /// ```
 ///
 /// Use instead:
 /// ```python
 /// def kos_root():
 ///     """Return the pathname of the KOS root directory."""
+///
+/// def kos_branch():
+///     """Return the branch name."""
 /// ```
 ///
 /// ## Formatter compatibility

docs/rules/triple-single-quotes.md

@@ -0,0 +1,60 @@
+# triple-single-quotes (D300)
+
+<small>
+Added in <a href="https://github.com/astral-sh/ruff/releases/tag/v0.0.69">v0.0.69</a> ·
+<a href="https://github.com/astral-sh/ruff/issues?q=sort%3Aupdated-desc%20is%3Aissue%20is%3Aopen%20(%27triple-single-quotes%27%20OR%20D300)" target="_blank">Related issues</a> ·
+<a href="https://github.com/astral-sh/ruff/blob/main/crates%2Fruff_linter%2Fsrc%2Frules%2Fpydocstyle%2Frules%2Ftriple_quotes.rs#L50" target="_blank">View source</a>
+</small>
+
+Derived from the **[pydocstyle](../rules.md#pydocstyle-d)** linter.
+
+Fix is sometimes available.
+
+## What it does
+
+Checks for docstrings that use single quotes (`'`) or triple single quotes (`'''`)
+instead of triple double quotes (`"""`).
+
+## Why is this bad?
+
+[PEP 257](https://peps.python.org/pep-0257/#what-is-a-docstring) recommends
+the use of `"""triple double quotes"""` for docstrings, to ensure
+consistency.
+
+## Example
+
+```python
+def kos_root():
+    '''Return the pathname of the KOS root directory.'''
+
+def kos_branch():
+    'Return the branch name.'
+```
+
+Use instead:
+
+```python
+def kos_root():
+    """Return the pathname of the KOS root directory."""
+
+def kos_branch():
+    """Return the branch name."""
+```
+
+## Formatter compatibility
+
+We recommend against using this rule alongside the [formatter]. The
+formatter enforces consistent quotes, making the rule redundant.
+
+## Options
+
+- [`lint.pydocstyle.ignore-decorators`][lint.pydocstyle.ignore-decorators]
+
+## References
+
+- [PEP 257 – Docstring Conventions](https://peps.python.org/pep-0257/)
+- [NumPy Style Guide](https://numpydoc.readthedocs.io/en/latest/format.html)
+- [Google Python Style Guide - Docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings)
+
+[formatter]: https://docs.astral.sh/ruff/formatter/
+[lint.pydocstyle.ignore-decorators]: ../settings.md#lint_pydocstyle_ignore-decorators