jsx-eslint/eslint-plugin-react

Inconsistent documentation: self-closing-comp.md

Open

#3,852 opened on Nov 16, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (2,797 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (8,630 stars)
PR merge metrics
 (No merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
javascriptreact
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90