JDK 13+ : Headings should start with `h2` and `h4`
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 45/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- java
- Bereich
- documentation
Rechercherichtung
Beginne damit, den für JDK 13+ beschriebenen Maven-Javadoc-Fehler zu reproduzieren, und lies JDK-8220379 zu den Regeln für Überschriften. Finde den Einstiegspunkt des Rezepts und die Tests für die Migration der Java-Dokumentation. Als erledigt gilt die Aufgabe, wenn Überschriften für Module, Pakete, Typen und verschachtelte Typen mit h2 beginnen, Überschriften für Member mit h4 beginnen und die Javadoc-Generierung erfolgreich ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Java
- Sterne
- 161
- Forks
- 134
- Ø Merge
- 4 Std. 50 Min.
- Gemergte PRs (30 T.)
- 107
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus openrewrite/rewrite-migrate-java
-
bug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100
openrewrite/rewrite-migrate-java#1383 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 30/100
openrewrite/rewrite-migrate-java#1330 · 5 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
UseMapOf: Skip refactoring large maps to Map.ofEntries to prevent javac compiler hangs (add maxEntries option)Evtl. vergeben @Yuren0312 hat das vor 6 Tagen übernommen. Offenbug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
openrewrite/rewrite-migrate-java#1310 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100
openrewrite/rewrite-migrate-java#1307 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 68/100
openrewrite/rewrite-migrate-java#1246 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in openrewrite/rewrite-migrate-java
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Maintainer antworten meist innerhalb von 1 Tag
-
[Bug]: WriteFileTool shows "Error reading file" snippet for relative paths when baseDir is setEvtl. vergeben @ShryukGrandhi hat das heute übernommen. Offen
Schwierigkeit 2/5 Unter einer Stunde Anfängerfreundlichkeit 86/100
agentscope-ai/agentscope-java#3917 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
intellij-elixir/intellij-elixir#4585 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
MetricsHub/metricshub-community#1474 ·
Maintainer antworten meist innerhalb von 1 Tag
-
go:build
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 60/100
Sanne/incus-spawn#1929 ·
Maintainer antworten meist innerhalb von 1 Tag