Converting warning-50-clean OCaml code results in misplaced doc comments
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 10.3k
- Forks
- 438
- PR merge metrics
- No merged PRs in 30d
Description
It seems that reasonfmt is not using the documentation comment attributes, and its own heuristics for comment association are incompatibly different. Is there a way to use the ocaml ast attributes? If so, then checking that ocaml code has no instances of warning 50 would be enough to ensure that converting it to reason would accurately preserve the documentation comments.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining reasonfmt's comment-association behavior and how OCaml AST documentation-comment attributes are exposed. Test a warning-50-clean OCaml example and confirm that conversion to Reason preserves its documentation comments without misplaced associations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100