Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ 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 don't use `"""triple double quotes"""`.
///
/// ## Why is this bad?
/// [PEP 257](https://peps.python.org/pep-0257/#what-is-a-docstring) recommends
Expand All @@ -19,12 +18,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
Expand Down