ruff/crates
Auguste Lalande f0318ff889
[pydoclint] Consider DOC201 satisfied if docstring begins with "Returns" (#12675)
<!--
Thank you for contributing to Ruff! To help us out with reviewing,
please consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

Resolves #12636

Consider docstrings which begin with the word "Returns" as having
satisfactorily documented they're returns. For example
```python
def f():
    """Returns 1."""
    return 1
```
is valid.

## Test Plan

Added example to test fixture.

---------

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
2024-08-06 06:46:38 +00:00
..
red_knot [red-knot] Rename workspace_root variables in the module resolver to src_root (#12697) 2024-08-05 23:07:18 +01:00
red_knot_module_resolver [red-knot] Rename workspace_root variables in the module resolver to src_root (#12697) 2024-08-05 23:07:18 +01:00
red_knot_python_semantic [red-knot] Infer float and complex literal expressions (#12689) 2024-08-06 06:24:28 +00:00
red_knot_workspace [red-knot] Rename workspace_root variables in the module resolver to src_root (#12697) 2024-08-05 23:07:18 +01:00
ruff Release Ruff 0.5.6 (#12629) 2024-08-02 17:35:14 +02:00
ruff_benchmark [red-knot] Rename workspace_root variables in the module resolver to src_root (#12697) 2024-08-05 23:07:18 +01:00
ruff_cache Fix cache key collisions for paths with separators (#12159) 2024-07-03 07:36:46 -05:00
ruff_db [red-knot] Rename workspace_root variables in the module resolver to src_root (#12697) 2024-08-05 23:07:18 +01:00
ruff_dev Drop deprecated nursery rule group (#10172) 2024-06-27 13:44:11 +02:00
ruff_diagnostics Move sub-crates to workspace dependencies (#11407) 2024-05-13 14:37:50 +00:00
ruff_formatter Upgrade to Rust 1.80 (#12586) 2024-07-30 19:18:08 +00:00
ruff_index [red-knot] small efficiency improvements and bugfixes to use-def map building (#12373) 2024-07-18 09:24:58 -07:00
ruff_linter [pydoclint] Consider DOC201 satisfied if docstring begins with "Returns" (#12675) 2024-08-06 06:46:38 +00:00
ruff_macros Drop deprecated nursery rule group (#10172) 2024-06-27 13:44:11 +02:00
ruff_notebook [red-knot] Add notebook support (#12338) 2024-07-17 08:26:33 +00:00
ruff_python_ast Upgrade to Rust 1.80 (#12586) 2024-07-30 19:18:08 +00:00
ruff_python_ast_integration_tests Rename PreorderVisitor to SourceOrderVisitor (#11798) 2024-06-07 17:01:58 +00:00
ruff_python_codegen Use indentation consistently (#12293) 2024-07-12 14:08:56 +02:00
ruff_python_formatter Upgrade to Rust 1.80 (#12586) 2024-07-30 19:18:08 +00:00
ruff_python_index Enable token-based rules on source with syntax errors (#11950) 2024-07-02 08:57:46 +00:00
ruff_python_literal Remove some unused pub functions (#11576) 2024-05-28 09:56:51 -04:00
ruff_python_parser Upgrade to Rust 1.80 (#12586) 2024-07-30 19:18:08 +00:00
ruff_python_resolver
ruff_python_semantic Make setting and retrieving pydocstyle settings less tedious (#12582) 2024-07-31 10:39:33 +01:00
ruff_python_stdlib Add a new script to generate builtin module names (#12696) 2024-08-05 21:33:36 +01:00
ruff_python_trivia Mention that Cursor is based on rustc's implementation. (#12109) 2024-06-30 16:53:25 +01:00
ruff_python_trivia_integration_tests Build CommentRanges outside the parser (#11792) 2024-06-09 09:55:17 +00:00
ruff_server Make server panic hook more error resilient (#12610) 2024-08-02 12:10:06 +02:00
ruff_source_file red-knot: source_text, line_index, and parsed_module queries (#11822) 2024-06-13 07:37:02 +00:00
ruff_text_size Upgrade to Rust 1.79 (#11875) 2024-06-17 07:15:10 +01:00
ruff_wasm Release Ruff 0.5.6 (#12629) 2024-08-02 17:35:14 +02:00
ruff_workspace Enable notebooks by default in preview mode (#12621) 2024-08-02 13:36:53 +00:00