jsx-eslint/eslint-plugin-react

Inconsistent documentation: self-closing-comp.md

Open

Aperta il 16 nov 2024

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)JavaScript (8630 star) (2797 fork)batch import
documentationhelp wanted

Descrizione

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.

Guida contributor

Tech stack
javascriptreact
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
basic markdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90
Direzione di ricerca
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.