Add PD002 use-of-inplace-argument documentation

README.md

@@ -1320,7 +1320,7 @@ For more, see [pandas-vet](https://pypi.org/project/pandas-vet/) on PyPI.
 
 | Code | Name | Message | Fix |
 | ---- | ---- | ------- | --- |
-| PD002 | use-of-inplace-argument | `inplace=True` should be avoided; it has inconsistent behavior | 🛠 |
+| PD002 | [use-of-inplace-argument](https://github.com/charliermarsh/ruff/blob/main/docs/rules/use-of-inplace-argument.md) | `inplace=True` should be avoided; it has inconsistent behavior | 🛠 |
 | PD003 | use-of-dot-is-null | `.isna` is preferred to `.isnull`; functionality is equivalent |  |
 | PD004 | use-of-dot-not-null | `.notna` is preferred to `.notnull`; functionality is equivalent |  |
 | PD007 | use-of-dot-ix | `.ix` is deprecated; use more explicit `.loc` or `.iloc` |  |

crates/ruff/src/rules/pandas_vet/rules/inplace_argument.rs

@@ -8,6 +8,29 @@ use crate::rules::pandas_vet::fixes::fix_inplace_argument;
 use crate::violation::AlwaysAutofixableViolation;
 
 define_violation!(
+    /// ## What it does
+    /// Checks for `inplace=True` in code using the `pandas` library.
+    ///
+    /// ## Why is this bad?
+    /// - `inplace=True` often does not provide a performance benefit. It is
+    /// likely to copy dataframes in the background.
+    /// - It encourages mutation rather than immutable data, which is harder to
+    /// reason about and may cause bugs.
+    /// - It removes the ability to use the method chaining style for `pandas`
+    /// code.
+    ///
+    /// ## Example
+    /// ```python
+    /// df.sort_values("col1", inplace=True)
+    /// ```
+    ///
+    /// Use instead:
+    /// ```python
+    /// sorted_df = df.sort_values("col1")
+    /// ```
+    ///
+    /// ## References
+    /// - [Why You Should Probably Never Use pandas inplace=True](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4)
     pub struct UseOfInplaceArgument;
 );
 impl AlwaysAutofixableViolation for UseOfInplaceArgument {

docs/rules/use-of-inplace-argument.md

@@ -0,0 +1,29 @@
+# use-of-inplace-argument (PD002)
+
+Derived from the **pandas-vet** linter.
+
+Autofix is always available.
+
+## What it does
+Checks for `inplace=True` in code using the `pandas` library.
+
+## Why is this bad?
+- `inplace=True` often does not provide a performance benefit. It is
+likely to copy dataframes in the background.
+- It encourages mutation rather than immutable data, which is harder to
+reason about and may cause bugs.
+- It removes the ability to use the method chaining style for `pandas`
+code.
+
+## Example
+```python
+df.sort_values("col1", inplace=True)
+```
+
+Use instead:
+```python
+sorted_df = df.sort_values("col1")
+```
+
+## References
+- [Why You Should Probably Never Use pandas inplace=True](https://towardsdatascience.com/why-you-should-probably-never-use-pandas-inplace-true-9f9f211849e4)