Doc-comment attributes: editor analysis accepts `@ocaml.doc`/`@ns.doc`, genType and the printer do not
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 25/100
Línea de trabajo
Read analysis/src/process_attributes.ml, compiler/gentype/annotation.ml, compiler/syntax/src/res_printer.ml, compiler/syntax/src/res_parsetree_viewer.ml, and tools/src/tools.ml, where the issue identifies inconsistent accepted attribute names. Align the readers with the parser’s @res.doc behavior and the stated decision to retain @ocaml.doc and @ns.doc. Check hover, doc output, genType comments, printing, and format-codeblocks; an open linked pull request #8992 already addresses this issue.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Found by differential semantic drift analysis from a7721303 to b123b7c3.
What is broken
The doc-comment attribute names are accepted inconsistently.
- Editor analysis, and through it hover and
rescript-tools doc, accepts@ocaml.doc,@ns.docand@res.doc(process_attributes.mlL7). - genType (
annotation.mlL36), the printer (res_printer.mlL6136,res_parsetree_viewer.mlL427) andrescript-tools format-codeblocks(tools.mlL867) accept only@res.doc. - The parser produces only
@res.doc.
So @ns.doc("Adds one") let inc = x => x + 1 shows "Adds one" on hover and in rescript-tools doc, while genType emits no doc comment for inc. #8928 edited this list (dropping ocaml.text) and kept the other two names on purpose; the other readers were not aligned with that decision.
Possible cause (speculation only)
A guess: #8805 and #8928 scoped their attribute cleanups to the compiler's own handling, and the readers in editor analysis and genType were decided separately.
- Lenguaje dominante
- OCaml
- Estrellas
- 7.5k
- Forks
- 483
- Merge medio
- 21 h 8 min
- PR fusionados (30 d)
- 183
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de rescript-lang/rescript
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
rescript-lang/rescript#8996 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 70/100
rescript-lang/rescript#8997 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 1-2 días Aptitud para principiantes 55/100
rescript-lang/rescript#8995 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
rescript-lang/rescript#8994 ·
Los mantenedores suelen responder en 1 día
-
Issues from differential semantic drift analysis (a7721303 to b123b7c3)Posiblemente ocupada @cknitt la tomó hace 1 día. Abierto
rescript-lang/rescript#8980 · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de rescript-lang/rescript
Issues similares
-
needs-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
11ty/buildawesome#4407 · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
area: image-engine bug priority: low
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
snapotter-hq/SnapOtter#3885 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
keyxmakerx/Chronicle#1721 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Gentleman-Programming/gentle-ai#5720 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día