Skip to content
Merged
Show file tree
Hide file tree
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 @@ -22,7 +22,7 @@ use crate::checkers::ast::Checker;
/// User.objects.all().extra(select={"test": "%secure" % "nos"})
/// ```
///
/// ## Use instead:
/// Use instead:
/// ```python
/// from django.contrib.auth.models import User
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::checkers::ast::Checker;
/// Using the generator more than once will do nothing on the second usage.
/// If that data is needed later, it should be stored as a list.
///
/// ## Examples:
/// ## Example:
/// ```python
/// import itertools
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use crate::rules::flake8_comprehensions::fixes;
///
/// In both cases, it's clearer and more efficient to avoid the redundant call.
///
/// ## Examples
/// ## Example
/// ```python
/// reversed(sorted(iterable))
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::rules::flake8_comprehensions::settings::Settings;
/// literal (`{}`). The former is slower because the name `dict` must be
/// looked up in the global scope in case it has been rebound.
///
/// ## Examples
/// ## Example
/// ```python
/// dict()
/// dict(a=1, b=2)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::rules::flake8_comprehensions::fixes;
/// It's unnecessary to use a dict/list/set comprehension to build a data structure if the
/// elements are unchanged. Wrap the iterable with `dict()`, `list()`, or `set()` instead.
///
/// ## Examples
/// ## Example
/// ```python
/// {a: b for a, b in iterable}
/// [x for x in iterable]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ use crate::rules::flake8_comprehensions::fixes;
/// short-circuiting it may not improve performance. (It may even slightly regress performance,
/// though the difference will usually be small.)
///
/// ## Examples
/// ## Example
/// ```python
/// any([x.id for x in bar])
/// all([x.id for x in bar])
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use crate::checkers::ast::Checker;
/// Prefer `dict.fromkeys(iterable)` over `{value: None for value in iterable}`,
/// as `dict.fromkeys` is more readable and efficient.
///
/// ## Examples
/// ## Example
/// ```python
/// {a: None for a in iterable}
/// {a: 1 for a in iterable}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::rules::flake8_comprehensions::fixes;
/// the listed functions within an additional `list()`, `set()`, `sorted()`, or
/// `tuple()` call. Doing so is redundant and can be confusing for readers.
///
/// ## Examples
/// ## Example
/// ```python
/// list(tuple(iterable))
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use super::helpers;
/// there are equivalent comprehensions for these types. Using a
/// comprehension is clearer and more idiomatic.
///
/// ## Examples
/// ## Example
/// ```python
/// dict((x, f(x)) for x in foo)
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use super::helpers;
/// `list(x for x in foo)`, it's better to use `list(foo)` directly, since it's
/// even more direct.
///
/// ## Examples
/// ## Example
/// ```python
/// list(f(x) for x in foo)
/// list(x for x in foo)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use super::helpers;
/// `set(x for x in foo)`, it's better to use `set(foo)` directly, since it's
/// even more direct.
///
/// ## Examples
/// ## Example
/// ```python
/// set(f(x) for x in foo)
/// set(x for x in foo)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use super::helpers;
/// ## Why is this bad?
/// It is redundant to use a `list()` call around a list comprehension.
///
/// ## Examples
/// ## Example
/// ```python
/// list([f(x) for x in foo])
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use super::helpers;
/// It's unnecessary to use a list comprehension inside a call to `dict()`,
/// since there is an equivalent comprehension for this type.
///
/// ## Examples
/// ## Example
/// ```python
/// dict([(x, f(x)) for x in foo])
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use super::helpers;
/// It's unnecessary to use a list comprehension inside a call to `set()`,
/// since there is an equivalent comprehension for this type.
///
/// ## Examples
/// ## Example
/// ```python
/// set([f(x) for x in foo])
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use super::helpers;
/// It's unnecessary to use a list or tuple literal within a call to `dict()`.
/// It can be rewritten as a dict literal (`{}`).
///
/// ## Examples
/// ## Example
/// ```python
/// dict([(1, 2), (3, 4)])
/// dict(((1, 2), (3, 4)))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use super::helpers;
/// It's unnecessary to use a list or tuple literal within a call to `set()`.
/// Instead, the expression can be rewritten as a set literal.
///
/// ## Examples
/// ## Example
/// ```python
/// set([1, 2])
/// set((1, 2))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use super::helpers;
/// call, since the literal or comprehension syntax already returns a
/// dictionary.
///
/// ## Examples
/// ## Example
/// ```python
/// dict({})
/// dict({"a": 1})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use super::helpers;
/// removed. Otherwise, if a tuple literal is passed in, then it should be
/// rewritten as a list literal.
///
/// ## Examples
/// ## Example
/// ```python
/// list([1, 2])
/// list((1, 2))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use super::helpers;
/// calls. If a list comprehension is found, it should be rewritten as a
/// generator expression.
///
/// ## Examples
/// ## Example
/// ```python
/// tuple([1, 2])
/// tuple((1, 2))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ use crate::rules::flake8_comprehensions::fixes;
/// - Instead of `dict(map(lambda v: (v, v ** 2), values))`, use
/// `{v: v ** 2 for v in values}`.
///
/// ## Examples
/// ## Example
/// ```python
/// map(lambda x: x + 1, iterable)
/// ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::checkers::ast::Checker;
/// into `reversed()`, `set()` or `sorted()` functions as they will change
/// the order of the elements again.
///
/// ## Examples
/// ## Example
/// ```python
/// sorted(iterable[::-1])
/// set(iterable[::-1])
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use super::helpers;
/// 6. `def get_absolute_url()`
/// 7. Any custom methods
///
/// ## Examples
/// ## Example
/// ```python
/// from django.db import models
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ impl AlwaysFixableViolation for AssignmentDefaultInStub {
}
}

/// ## What it does?
/// ## What it does
/// Checks for unannotated assignments in stub (`.pyi`) files.
///
/// ## Why is this bad?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use ruff_text_size::Ranged;
/// if the given suffix is not prefixed with a dot
/// or it is a single dot `"."`.
///
/// ## Examples
/// ## Example
///
/// ```python
/// path.with_suffix("py")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use ruff_macros::{derive_message_formats, ViolationMetadata};
/// improve readability over the `os.path` module's counterparts (e.g.,
/// `os.path.getatime()`).
///
/// ## Examples
/// ## Example
/// ```python
/// import os
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use ruff_macros::{derive_message_formats, ViolationMetadata};
/// improve readability over the `os.path` module's counterparts (e.g.,
/// `os.path.getctime()`).
///
/// ## Examples
/// ## Example
/// ```python
/// import os
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use ruff_macros::{derive_message_formats, ViolationMetadata};
/// improve readability over the `os.path` module's counterparts (e.g.,
/// `os.path.getmtime()`).
///
/// ## Examples
/// ## Example
/// ```python
/// import os
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use ruff_macros::{derive_message_formats, ViolationMetadata};
/// improve readability over the `os.path` module's counterparts (e.g.,
/// `os.path.getsize()`).
///
/// ## Examples
/// ## Example
/// ```python
/// import os
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::importer::ImportRequest;
///
/// Prefer newer APIs over deprecated ones.
///
/// ## Examples
/// ## Example
/// ```python
/// import numpy as np
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use crate::checkers::ast::Checker;
/// Note, however, that `np.bool` and `np.long` were reintroduced in 2.0 with
/// different semantics, and are thus omitted from this rule.
///
/// ## Examples
/// ## Example
/// ```python
/// import numpy as np
///
Expand Down
2 changes: 1 addition & 1 deletion crates/ruff_linter/src/rules/numpy/rules/legacy_random.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ use crate::checkers::ast::Checker;
/// See the documentation on [Random Sampling] and [NEP 19] for further
/// details.
///
/// ## Examples
/// ## Example
/// ```python
/// import numpy as np
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ use crate::importer::ImportRequest;
/// This rule flags all uses of removed members, along with automatic fixes for
/// any backwards-compatible replacements.
///
/// ## Examples
/// ## Example
/// ```python
/// import numpy as np
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::checkers::ast::Checker;
/// If a class definition doesn't have any bases, the parentheses are
/// unnecessary.
///
/// ## Examples
/// ## Example
/// ```python
/// class Foo():
/// ...
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use crate::checkers::ast::Checker;
/// Omitting type arguments that match the default values can make the code
/// more concise and easier to read.
///
/// ## Examples
/// ## Example
///
/// ```python
/// from collections.abc import Generator, AsyncGenerator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::checkers::ast::Checker;
/// the use of `from_float` and `from_decimal` methods is unnecessary, and
/// should be avoided in favor of the more concise constructor syntax.
///
/// ## Examples
/// ## Example
/// ```python
/// Decimal.from_float(4.2)
/// Decimal.from_float(float("inf"))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ use crate::checkers::ast::Checker;
/// which may result in unexpected behavior (e.g., undefined variable
/// accesses).
///
/// ## Examples
/// ## Example
/// ```python
/// assert (x := 0) == 0
/// print(x)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ use crate::Locator;
/// keyword to a positional argument will change the behavior of the code, even
/// if the keyword argument was used erroneously.
///
/// ## Examples
/// ## Example
/// ```python
/// defaultdict(default_factory=int)
/// defaultdict(default_factory=list)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ use crate::rules::ruff::rules::helpers::{
/// Attributes whose default arguments are `NewType` calls
/// where the original type is immutable are ignored.
///
/// ## Examples
/// ## Example
/// ```python
/// from dataclasses import dataclass
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ use super::suppression_comment_visitor::{
/// Suppression comments that do not actually prevent formatting could cause unintended changes
/// when the formatter is run.
///
/// ## Examples
/// ## Example
/// In the following example, all suppression comments would cause
/// a rule violation.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use crate::rules::ruff::rules::helpers::{dataclass_kind, is_class_var_annotation
/// If the default value is intended to be mutable, it must be annotated with
/// `typing.ClassVar`; otherwise, a `ValueError` will be raised.
///
/// ## Examples
/// ## Example
/// ```python
/// from dataclasses import dataclass
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use crate::checkers::ast::Checker;
/// without having to check if the dictionary contains the relevant key,
/// returning `None` if the key is not present.
///
/// ## Examples
/// ## Example
/// ```python
/// if "key" in dct and dct["key"]:
/// ...
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use ruff_text_size::Ranged;
/// ## Why is this bad?
/// It's unnecessary to use an empty literal as a deque's iterable, since this is already the default behavior.
///
/// ## Examples
/// ## Example
///
/// ```python
/// from collections import deque
Expand Down
2 changes: 1 addition & 1 deletion crates/ruff_linter/src/rules/ruff/rules/unused_async.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::rules::fastapi::rules::is_fastapi_route;
/// contexts where that function may be called. In some cases, labeling a function `async` is
/// semantically meaningful (e.g. with the trio library).
///
/// ## Examples
/// ## Example
/// ```python
/// async def foo():
/// bar()
Expand Down
Loading