mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-01 22:31:23 +00:00
Document use of anonymous assignment in useless-expression
(#10551)
Closes https://github.com/astral-sh/ruff/issues/10536.
This commit is contained in:
parent
39fb6d9bfc
commit
9856c1446b
1 changed files with 20 additions and 0 deletions
|
@ -25,6 +25,26 @@ use super::super::helpers::at_last_top_level_expression_in_cell;
|
||||||
/// ```python
|
/// ```python
|
||||||
/// foo = 1 + 1
|
/// foo = 1 + 1
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// ## Known problems
|
||||||
|
/// This rule ignores expression types that are commonly used for their side
|
||||||
|
/// effects, such as function calls.
|
||||||
|
///
|
||||||
|
/// However, if a seemingly useless expression (like an attribute access) is
|
||||||
|
/// needed to trigger a side effect, consider assigning it to an anonymous
|
||||||
|
/// variable, to indicate that the return value is intentionally ignored.
|
||||||
|
///
|
||||||
|
/// For example, given:
|
||||||
|
/// ```python
|
||||||
|
/// with errors.ExceptionRaisedContext():
|
||||||
|
/// obj.attribute
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Use instead:
|
||||||
|
/// ```python
|
||||||
|
/// with errors.ExceptionRaisedContext():
|
||||||
|
/// _ = obj.attribute
|
||||||
|
/// ```
|
||||||
#[violation]
|
#[violation]
|
||||||
pub struct UselessExpression {
|
pub struct UselessExpression {
|
||||||
kind: Kind,
|
kind: Kind,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue