astral-sh/ruff

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

Open

#15 217 ouverte le 2 janv. 2025

Voir sur GitHub
 (1 commentaire) (3 réactions) (0 assignés)Rust (47 527 stars) (2 088 forks)batch import
documentationhelp wanted

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.

Guide contributeur

Stack technique
pythonrust
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of Ruff's pydocstyle rulesFamiliarity with Ruff documentation structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85
Direction de recherche
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.