jsx-eslint/eslint-plugin-react

Inconsistent documentation: self-closing-comp.md

Open

#3.852 aberto em 16 de nov. de 2024

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (8.630 stars) (2.797 forks)batch import
documentationhelp wanted

Description

Currently in self-closing-comp.md, the first correct includes var contentContainer = <div className="content"></div>;. Given the rest of that section, the default options, and further examples below this should be in the incorrect section or the description for these examples should indicate the html option is set to false.

Guia do colaborador

Pilha de tecnologia
javascriptreact
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic markdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
The issue points out that in the file docs/rules/self closing comp.md at line 22, the first 'correct' example is actually incorrect given the default options. The fix is to move that example to the 'incorrect' section or update the description to clarify that the 'html' option is set to 'false'. No linked PRs exist; the fix is straightforward.