5 commits

Author	SHA1	Message	Date
Charlie Marsh	e7248ee43e	Avoid treating newline-separated sections as sub-sections (#15311) ... ## Summary Closes https://github.com/astral-sh/ruff/issues/15224.	2025-01-06 22:13:35 -05:00
Alex Waygood	281e6d9791	[pydocstyle] Improve heuristics for detecting Google-style docstrings (#13142)	2024-08-29 16:33:18 +01:00
Mikko Leppänen	b4f2882b72	[pydocstyle-D405] Allow using parameters as a sub-section header (#9894) ... ## Summary This review contains a fix for [D405](https://docs.astral.sh/ruff/rules/capitalize-section-name/) (capitalize-section-name) The problem is that Ruff considers the sub-section header as a normal section if it has the same name as some section name. For instance, a function/method has an argument named "parameters". This only applies if you use Numpy style docstring. See: [ISSUE](https://github.com/astral-sh/ruff/issues/9806) The following will not raise D405 after the fix: ```python def some_function(parameters: list[str]): """A function with a parameters parameter Parameters ---------- parameters: A list of string parameters """ ... ``` ## Test Plan ```bash cargo test ``` --------- Co-authored-by: Mikko Leppänen <mikko.leppanen@vaisala.com> Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>	2024-02-08 21:54:32 -05:00
Charlie Marsh	04afdf177b	Disambiguate argument descriptors from section headers (#9427) ... ## Summary Given a docstring like: ```python def func(x: int, args: tuple[int]): """Toggle the gizmo. Args: x: Some argument. args: Some other arguments. """ ``` We were considering the `args:` descriptor to be an indented docstring section header (since `Args:`) is a valid header name. This led to very confusing diagnostics. This PR makes the parsing a bit more lax in this case, such that if we see a nested header that's more deeply indented than the preceding header, and the preceding section allows sub-items (like `Args:`), we avoid treating the nested item as a section header. Closes https://github.com/astral-sh/ruff/issues/9426.	2024-01-07 22:41:00 -05:00
Charlie Marsh	5849a75223	Rename ruff crate to ruff_linter (#7529)	2023-09-20 08:38:27 +02:00

Renamed from crates/ruff/resources/test/fixtures/pydocstyle/sections.py (Browse further)