astral-sh/ruff

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

Geschlossen

#15.217 geöffnet am 02.01.2025

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (3 Reaktionen) (0 zugewiesene Personen)Rust (2.088 Forks)batch import
documentationhelp wanted

Repository-Metriken

Stars
 (47.527 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 8h) (573 gemergte PRs in 30 T)

Beschreibung

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-Richtung
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
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic understanding of Ruff's pydocstyle rulesFamiliarity with Ruff documentation structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85