Js.t objects generate invalid signatures
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 114
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
For example, the following code:
```reason
type point = {
.
"x": float,
"y": float,
};
```
Generates this line of documentation:
```reason
type point = Js.t(< x : float; y : float >)
```
This is invalid Reason and looks to be a combination of Reason and OCaml syntax. As far as I have seen this happens for every `Js.t` type.
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
No source file or test is named. Reproduce the supplied Js.t example, then locate the documentation-generation entry point that formats the signature and compare its output with valid Reason syntax. Done means Js.t types no longer produce mixed Reason and OCaml notation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100