Skip to content

docs: fix doc comment bugs in List, Promise, and Float#259

Open
mikaello wants to merge 5 commits intorescript-lang:mainfrom
mikaello:fix-doc
Open

docs: fix doc comment bugs in List, Promise, and Float#259
mikaello wants to merge 5 commits intorescript-lang:mainfrom
mikaello:fix-doc

Conversation

@mikaello
Copy link
Copy Markdown

@mikaello mikaello commented Apr 22, 2026

Fix several documentation bugs found in doc comments:

  • List.fromInitializer: description referenced old name makeBy (same as Fix doc to use correct function #255)
  • List.reduceReverse2: description said reduce2 returns the final value
  • Promise.all6 / allSettled6: parameter list was missing p3 (had p1, p2, p4, p5, p6), and the comment closing was malformed (")*/)
  • Float.Constants.maxValue: example showed minValue instead of maxValue
  • List (forEachWithIndex): Item 2 is cc → Item 2 is c (copy-paste typo)
  • RegExp (sticky + unicode): example called RegExp.unicode instead of RegExp.sticky, and unicode description said flag was y instead of u

- fromInitializer was documented as makeBy
- reduceReverse2 was documented as reduce2 in its own doc comment
- p3 was missing from parameter list (had p1, p2, p4, p5, p6)
- malformed comment closing ")*/" fixed to "*/"
@fhammerschmidt
Copy link
Copy Markdown
Member

fhammerschmidt commented Apr 22, 2026

Thanks! ReScript Core has moved into the main ReScript repo again. So please apply your fixes there first.

It's just called Stdlib internally in order to make migrations easier (no name clashes).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants