astral-sh/ruff

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

Fechada

#15.217 aberto em 2 de jan. de 2025

Ver no GitHubGuia do colaborador
 (1 comentário) (3 reações) (0 responsável)Rust (2.088 forks)batch import
documentationhelp wanted

Métricas do repositório

Stars
 (47.527 estrelas)
Métricas de merge de PR
 (Mesclagem média 3d 8h) (573 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
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.
Pilha de tecnologia
pythonrust
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic understanding of Ruff's pydocstyle rulesFamiliarity with Ruff documentation structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85