Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ruff/crates/ruff_linter/resources/test/fixtures/pydocstyle
History
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
..
D104 Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
_unrelated Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D.py Fix panic in D208 with multibyte indent (#9147) 2023-12-15 12:02:15 -05:00
D100.ipynb Avoid `D100` for Jupyter Notebooks (#8816) 2023-11-22 15:26:25 +00:00
D200.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D202.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D208.py Convert over-indentation rule to use number of characters (#8983) 2023-12-03 20:45:30 +00:00
D209_D400.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D214_module.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D215.py Use deletion for D215 full-line removals (#7625) 2023-09-23 22:44:55 +00:00
D300.py `D300`: prevent autofix when both triples are in body (#8462) 2023-11-03 12:49:50 -04:00
D301.py Avoid `D301` autofix for `u` prefixed strings (#8495) 2023-11-05 09:45:49 -05:00
D400.py Ignore underlines when determining docstring logical lines (#8929) 2023-11-30 14:27:04 -05:00
D401.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D403.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D410.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
D413.py [`pydocstyle`] Re-implement `last-line-after-section` (`D413`) (#9654) 2024-01-26 19:30:59 +00:00
D417.py Disambiguate argument descriptors from section headers (#9427) 2024-01-07 22:41:00 -05:00
all.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
bom.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
canonical_google_examples.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
canonical_numpy_examples.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00
sections.py [`pydocstyle-D405`] Allow using `parameters` as a sub-section header (#9894) 2024-02-08 21:54:32 -05:00
setter.py Rename `ruff` crate to `ruff_linter` (#7529) 2023-09-20 08:38:27 +02:00