JDK 13+ : Headings should start with `h2` and `h4`
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 45/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- java
- Domaine
- documentation
Piste de recherche
Commencez par reproduire l'échec de Maven Javadoc décrit pour JDK 13+ et lisez JDK-8220379 concernant les règles de titres. Localisez le point d'entrée de la recette et les tests pour la migration de la documentation Java ; le travail est terminé lorsque les titres des modules, packages, types et types imbriqués commencent par h2, que les titres des membres commencent par h4 et que la génération de Javadoc réussit.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- Java
- Étoiles
- 160
- Forks
- 133
- Merge moyen
- 5 h 51 min
- PR mergées (30 j)
- 86
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de openrewrite/rewrite-migrate-java
-
good first issue
Difficulté 4/5 3-5 jours Accessibilité débutants 30/100
openrewrite/rewrite-migrate-java#1330 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 72/100
openrewrite/rewrite-migrate-java#1319 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
openrewrite/rewrite-migrate-java#1314 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 55/100
openrewrite/rewrite-migrate-java#1310 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 4/5 3-5 jours Accessibilité débutants 55/100
openrewrite/rewrite-migrate-java#1307 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de openrewrite/rewrite-migrate-java
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Les mainteneurs répondent en général sous 1 jour
-
code-maintenance
Difficulté 2/5 1-3 heures Accessibilité débutants 80/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
krizaka/krizaka-notifications#32 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
klikli-dev/occultism#1719 ·