From b6c8f5d79e074012c303b37a87b7b45b90c7ff2f Mon Sep 17 00:00:00 2001 From: Arnav Gupta Date: Sun, 22 Dec 2024 21:00:16 -0800 Subject: [PATCH] Fix `RUF200` doc to have name and email in single object (#15099) ## Summary Closes #14975 by modifying the docstring of the InvalidPyprojectToml rule. Previously the docs were incorrectly stating that author name and emails must be individual items in the authors list, rather than part of a single object for each respective author. ## Test Plan This was a docstring change, no tests needed. --- .../ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs b/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs index b9a1c2f3a7ed0..290f2da3e9079 100644 --- a/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs +++ b/crates/ruff_linter/src/rules/ruff/rules/invalid_pyproject_toml.rs @@ -21,8 +21,7 @@ use ruff_macros::{derive_message_formats, ViolationMetadata}; /// name = "crab" /// version = "1.0.0" /// authors = [ -/// { email = "ferris@example.org" }, -/// { name = "Ferris the Crab"} +/// { name = "Ferris the Crab", email = "ferris@example.org" } /// ] /// ``` ///