docs: fix doc comment bugs in List, Promise, and Float#259
Open
mikaello wants to merge 5 commits intorescript-lang:mainfrom
Open
docs: fix doc comment bugs in List, Promise, and Float#259mikaello wants to merge 5 commits intorescript-lang:mainfrom
mikaello wants to merge 5 commits intorescript-lang:mainfrom
Conversation
- 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 "*/"
Member
|
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix several documentation bugs found in doc comments:
List.fromInitializer: description referenced old namemakeBy(same as Fix doc to use correct function #255)List.reduceReverse2: description saidreduce2returns the final valuePromise.all6/allSettled6: parameter list was missingp3(hadp1, p2, p4, p5, p6), and the comment closing was malformed (")*/)Float.Constants.maxValue: example showedminValueinstead ofmaxValueRegExp.unicodeinstead ofRegExp.sticky, and unicode description said flag was y instead of u