Doc-comment attributes: editor analysis accepts `@ocaml.doc`/`@ns.doc`, genType and the printer do not
Maintainer antworten meist innerhalb von 1 Tag
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 25/100
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- OCaml
- Sterne
- 7.5k
- Forks
- 483
- Ø Merge
- 21 Std. 8 Min.
- Gemergte PRs (30 T.)
- 183
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine 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 rescript-lang/rescript
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
rescript-lang/rescript#8996 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 70/100
rescript-lang/rescript#8997 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 4/5 1-2 Tage Anfängerfreundlichkeit 55/100
rescript-lang/rescript#8995 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
rescript-lang/rescript#8994 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Issues from differential semantic drift analysis (a7721303 to b123b7c3)Evtl. vergeben @cknitt hat das vor 1 Tag übernommen. Offen
rescript-lang/rescript#8980 · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in rescript-lang/rescript
Ähnliche Issues
-
area-multitenancy area-security p1-recommended priority-high technical-debt
Schwierigkeit 2/5 Unter einer Stunde Anfängerfreundlichkeit 75/100
Maintainer antworten meist innerhalb von 1 Tag
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefixEvtl. vergeben @ItsDeadlyProgrammer hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
appsmithorg/appsmith#42471 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
fossasia/visdom-dev#77 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
volcengine/OpenViking#6521 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Status: Triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
mermaid-js/mermaid#8546 ·
Maintainer antworten meist innerhalb von 1 Tag