Skip to content

Commit

Permalink
Update docs for literal-comparisons (#4560)
Browse files Browse the repository at this point in the history
- Link to the relevant GH issue instead of copying examples/alternatives from the GH issue.
  • Loading branch information
psychedelicious committed Jun 18, 2024
1 parent 93819e2 commit 70a9270
Showing 1 changed file with 6 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,11 @@ impl EqCmpOp {
///
/// This rule's fix is marked as unsafe, as it may alter runtime behavior when
/// used with libraries that override the `==`/`__eq__` or `!=`/`__ne__` operators.
/// In these cases, `is`/`is not` may not be equivalent to `==`/`!=`.
///
/// Notable examples and alternatives include:
/// - `pandas.DataFrame`, often used with `DataFrame.mask`, `DataFrame.where` - see [pandas.DataFrame.eq].
/// - `pandas.Series`, often used with `Series.mask`, `Series.where` - see [pandas.Series.eq].
/// - `sqlalchemy.Column`, often used with `Query.having`, `Query.filter`, `Query.where` - see [sqlalchemy.sql.expression.ColumnOperators.is_].
/// - `numpy.Array`, often used with `Array.where` - no alternative.
/// In these cases, `is`/`is not` may not be equivalent to `==`/`!=`. For more
/// information, see [this issue].
///
/// [PEP 8]: https://peps.python.org/pep-0008/#programming-recommendations
/// [pandas.Series.eq]: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.eq.html
/// [pandas.DataFrame.eq]: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.eq.html
/// [sqlalchemy.sql.expression.ColumnOperators.is_]: https://docs.sqlalchemy.org/en/20/core/sqlelement.html#sqlalchemy.sql.expression.ColumnOperators.is_
/// [this issue]: https://github.com/astral-sh/ruff/issues/4560
#[violation]
pub struct NoneComparison(EqCmpOp);

Expand Down Expand Up @@ -120,18 +113,11 @@ impl AlwaysFixableViolation for NoneComparison {
///
/// This rule's fix is marked as unsafe, as it may alter runtime behavior when
/// used with libraries that override the `==`/`__eq__` or `!=`/`__ne__` operators.
/// In these cases, `is`/`is not` may not be equivalent to `==`/`!=`.
///
/// Notable examples and alternatives include:
/// - `pandas.DataFrame`, often used with `DataFrame.mask`, `DataFrame.where` - see [pandas.DataFrame.eq].
/// - `pandas.Series`, often used with `Series.mask`, `Series.where` - see [pandas.Series.eq].
/// - `sqlalchemy.Column`, often used with `Query.having`, `Query.filter`, `Query.where` - see [sqlalchemy.sql.expression.ColumnOperators.is_].
/// - `numpy.Array`, often used with `Array.where` - no alternative.
/// In these cases, `is`/`is not` may not be equivalent to `==`/`!=`. For more
/// information, see [this issue].
///
/// [PEP 8]: https://peps.python.org/pep-0008/#programming-recommendations
/// [pandas.Series.eq]: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.eq.html
/// [pandas.DataFrame.eq]: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.eq.html
/// [sqlalchemy.sql.expression.ColumnOperators.is_]: https://docs.sqlalchemy.org/en/20/core/sqlelement.html#sqlalchemy.sql.expression.ColumnOperators.is_
/// [this issue]: https://github.com/astral-sh/ruff/issues/4560
#[violation]
pub struct TrueFalseComparison {
value: bool,
Expand Down

0 comments on commit 70a9270

Please sign in to comment.