astral-sh/ruff

Make docstring convention a global setting

Open

#9,043 opened on Dec 7, 2023

View on GitHub
 (12 comments) (7 reactions) (0 assignees)Rust (47,527 stars) (2,088 forks)batch import
configurationhelp wanted

Description

Pydocstyle has a setting to specify the used docstring convention:

[tool.ruff.lint.pydocstyle]
convention = "google"

Pylint also has rules for docstrings and profits from setting the used convention. #8843 introduces one of those rules and adds a convention setting specific to Pylint.

I think that having two different settings for the convention is not very intuitive as a user and might hinder efforts to unify settings and rules later on if someone actually selects two different conventions for Pydocstyle and Pylint checks (no idea why someone would do that but there's always someone out there). Having a other tools, like a docstring formatter, in the future would further complicate things. The setting should therefore not only be global to linting, but global to all tools.

I propose to turn Pydocstyle's convention setting into a global setting to make it usable by the Pylint rules and other tools, like formatters. A strategy could look like the following:

  • Add a docstring-convention setting under [tool.ruff]
  • Deprecate the Pydocstyle setting (and Pylint's if #8843 gets merged in its current form) in favor of the new setting
  • Only mention the global setting in the docs
  • Remove the original setting at some point in the future (is Ruff's deprecation process based on time or releases?)

Contributor guide

Tech stack
pythonrust
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingPython tooling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue proposes adding a global `docstring convention` setting under `[tool.ruff]` in the Ruff config. The implementation should move the existing pydocstyle convention setting to a global scope and deprecate the old one. Reference the new setting from pylint rules as well. Review the existing settings structure in `ruff/settings.rs` and `ruff/linter/settings.rs`. Look at how other global settings like `target version` are implemented. Also check the deprecation policy in the CONTRIBUTING.md. After adding the setting, update the documentation and ensure backward compatibility.