Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

JDK 13+ : Headings should start with `h2` and `h4`

Aperta
  • Qualcosa non va?
#208 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia riproducendo il fallimento di Maven Javadoc descritto per JDK 13+ e leggi JDK-8220379 sulle regole per le intestazioni. Individua il punto di ingresso della recipe e i test per la migrazione della documentazione Java; il lavoro è completato quando le intestazioni di moduli, package, tipi e tipi annidati iniziano con h2, le intestazioni dei membri iniziano con h4 e la generazione di Javadoc ha esito positivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

recipe 
Headings in documentation comments for all modules, packages and types (including nested types) should begin at <h2>.
Headings in members should begin at <h4>.

Currently, this leads to the following failure:

MavenReportException: Error while generating Javadoc: 
[ERROR] Exit code: 1
[ERROR] /MyClass.java:24: error: unexpected heading used: <H1>, compared to implicit preceding heading: <H1>
[ERROR]  * <h1>My heading</h1>

Changing it to <h2> is enough to fix it

See https://bugs.openjdk.org/browse/JDK-8220379

Lingua principale
Java
Stelle
156
Fork
129
Merge medio
14h 30m
PR unite (30g)
43

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openrewrite/rewrite-migrate-java

Tutte le issue di openrewrite/rewrite-migrate-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.