rescript-lang / rescript-lang/rescript-lang.org
Add documentation for rescript format / the formatter in general
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 1.9k
- Forks
- 260
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 17
Description
We should dedicate a page to the formatter, since there is smart printing / format -all / format -check which are all features that should be documented somewhere.
Related forum post: https://forum.rescript-lang.org/t/ann-smart-linebreaks-for-pipe-chains/4734
Contributor guide
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 reviewing the formatter features named in the issue and the related forum post about smart linebreaks for pipe chains. Done means adding a dedicated documentation page covering smart printing, format -all, and format -check.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100