jsx-eslint/eslint-plugin-react

Inconsistent documentation: self-closing-comp.md

Open

#3.852 geöffnet am 16. Nov. 2024

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (8.630 Stars) (2.797 Forks)batch import
documentationhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javascriptreact
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic markdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.