astral-sh/ruff

Improve discoverability of the `pydocstyle` rules as per the selected convention

Closed

#15,217 opened on Jan 2, 2025

View on GitHubContributor guide
 (1 comment) (3 reactions) (0 assignees)Rust (2,088 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (47,527 stars)
PR merge metrics
 (Avg merge 3d 8h) (573 merged PRs in 30d)

Description

If a user has D in the rule selection, the rules that are actually selected depends on the docstring convention that's chosen. Currently, this information only lives at the bottom of this FAQ section: https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. It would be useful to have this visible in an obvious place for which I see two options:

  1. ruff.lint.pydocstyle.convention section
  2. For each of the Dxxx rule page, specify how setting the lint.pydocstyle.convention may affect the selection of this rule

I think I'd prefer option (1) as the documentation is in a single place instead of distributed across multiple rule pages.

Contributor guide

Research direction
Look at the current documentation in the FAQ section (docs.astral.sh/ruff/faq) and the settings page for `lint.pydocstyle.convention` (docs.astral.sh/ruff/settings/#lint pydocstyle convention). The issue suggests adding a list of rules affected by each convention to the settings page, so examine that page's structure. Also consider the rule page templates for `Dxxx` rules to see if they include relevant cross references. The main goal is to decide between two options and implement the chosen one.
Tech stack
pythonrust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
Basic understanding of Ruff's pydocstyle rulesFamiliarity with Ruff documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85