Sync Belt / Js doc headers #5361
Merged
Conversation
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
ryyppy
force-pushed
the
sync-belt-doc-headers
branch
from
71f6b25 to
1728a0c
Compare
|
Made a PR for |
|
I'll start with |
|
Created #5442 for |
|
Created #5443 for |
Sync docs for js_math.ml
Sync docs for js_option.ml
Sync docs for js_re.ml
|
Alright, things that are now done:
Now the next step is to convert all of those files from mli / ml to res (will probably do that in a separate PR). Follow-up task will be handling the issue with cppo files as described in #5458. |
|
Wonderful! |
mununki
pushed a commit
to mununki/rescript-compiler
that referenced
this pull request
Jul 15, 2022
* Sync doc headers for belt.ml * Sync doc headers for belt_Array.mli * Update belt_Float.mli doc headers * Sync docs for belt_HashMap.mli * Sync docs for belt_HashMapInt.mli * Sync docs for belt_HashMapString.mli * Sync belt_HashSet.mli * Update belt_HashMapInt * Sync belt_HashSetString.mli * Sync docs for belt_Int.mli * Sync docs for belt_List.mli * Sync docs for belt_Option.mli * Adapt docs in belt_Option.mli for parts missing in rescript-lang.org MDX * Sync docs for belt_Result.mli * Sync docs for belt_Set.mli * Sync docs for belt_SetInt.mli * Sync docs for belt_SetString.mli * Sync docs for belt_SetDict.mli * Sync docs for belt_MutableSetInt.mli * Sync docs for belt_MutableSetString.mli * Sync all the docstring texts from sort-array.mdx * Remove duplication of type definitions * Sync all the docstring texts from sort-array-int.mdx * Sync docs for belt_Map.mli * Sync docs for belt_MapInt.mli * Sync docs for belt_MapString.mli * Sync docs for belt_MutableMap.mli * Sync docs for belt_MutableMapInt.mli * Sync docs for belt_MutableMapString.mli * Remove duplicate type signatures * Sync all the docstring texts from sort-array-string.mdx * Sync docs for belt_MutableSet.mli * Sync docs for belt_Range.mli * Sync docs for belt_MutableQueue.mli * Sync docs for belt_MutableStack.mli * Sync docs for Js.ml * Sync docs for js_array.ml * Sync docs for js_array2.ml * Sync docs for js_date.ml * Sync docs for js_dict.mli * Sync docs for js_exn.mli * Sync docs for js_float.ml * Sync docs for js_math.ml * Sync docs for js_option.ml * Sync docs of js_global.ml * Sync docs for js_int.ml * Sync docs for js_re.ml * Sync docs for js_json.mli * Sync docs for js_null.mli * Sync docs for js_null_undefined * Sync docs for js_obj.ml * Sync docs for js_promise.ml * Sync docs for js_string.ml * Fix misplaced doc in js_array2 * Sync docs for js_string2.ml * Update docs for js_types.mli * Sync docs for js_undefined.mli * Sync docs for js_vector.mli Co-authored-by: Patrick Ecker <ryyppy@users.noreply.github.com> Co-authored-by: Victor Nakoryakov <nail.xx@gmail.com> Co-authored-by: Whit Chapman <whit.chapman@gmail.com> Co-authored-by: jihchi <achi@987.tw> Co-authored-by: Bart Schuurmans <bart@minnozz.com>
29 tasks
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.
Fixes #4872
This PR syncs back all our written docs from our docs website (see this directory for reference).
Goal is to rescriptify all the inline code examples and later on use the original source as the source of truth for our language api generation.
Lots of manual work, but will be worthwhile.
belt.mlbelt_Array.mlibelt_Float.mlibelt_HashMap.mlibelt_HashMapInt.mlibelt_HashMapString.mlibelt_HashSet.mlibelt_HashSetInt.mlibelt_HashSetString.mlibelt_Id.mlibelt_Int.mlibelt_List.mlibelt_Map.mlibelt_MapDict.mlibelt_MapInt.mlibelt_MapString.mlibelt_MutableMap.mlibelt_MutableMapInt.mlibelt_MutableMapString.mlibelt_MutableQueue.mlibelt_MutableSet.mlibelt_MutableSetInt.mlibelt_MutableSetString.mlibelt_MutableStack.mlibelt_Option.mlibelt_Range.mlibelt_Result.mlibelt_Set.cppo.mlibelt_Set.mlibelt_SetDict.mlibelt_SetInt.mlibelt_SetString.mlibelt_SortArray.mlibelt_SortArrayInt.mlibelt_SortArrayString.mliStep 1) Syncing up the docs is done.
Step 2) Transform
mlfiles tores