-
-
Notifications
You must be signed in to change notification settings - Fork 252
Sync v12 core docs #991
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Sync v12 core docs #991
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
45ff717
WIP sync stdlib docs (Js does not work for now)
tsnobip bcb7c2d
rename core to stdlib for >= v12
tsnobip 403b2e3
fix doc generation for v12
tsnobip 3caf7f9
fix version selector for core/stdlib
tsnobip 3a4c988
add missing react keys
tsnobip b99b3a5
update stdlib.json
tsnobip f4a9971
remove unused flag
tsnobip c634f36
fix selector for non core/stdlib modules
tsnobip 05af321
revert gendocs.res since it'll be moved to rescript monorepo
tsnobip 9adeb35
fix iterator docstrings
tsnobip File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
10,339 changes: 6,124 additions & 4,215 deletions
10,339
data/api/v12.0.0/core.json → data/api/v12.0.0/stdlib.json
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,20 @@ | ||
# Overview | ||
|
||
## ReScript Core | ||
## Stdlib | ||
|
||
[Core](api/core) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode. | ||
[Stdlib](api/stdlib) is ReScript's new standard library. It replaces the complete `Js` module as well as some of the more frequently used modules from `Belt` and is recommended to use with uncurried mode. | ||
|
||
In ReScript 11, it is shipped as a separate npm package `@rescript/core` that is added to your project as per the [installation instructions](/docs/manual/next/installation). In future ReScript versions, it will be included with the `rescript` npm package itself. | ||
In ReScript 11, it was shipped as a separate npm package `@rescript/core`. | ||
|
||
Since Rescript 12, it is now included with the `rescript` npm package itself. | ||
|
||
## Additional Libraries | ||
|
||
ReScript ships with these two additional modules in its standard library: | ||
|
||
- [Belt](api/belt): immutable collections and extra helpers not available in [Core](api/core). | ||
- [Dom](api/dom): Dom related types and modules. Contains our standardized types used by various userland DOM bindings. | ||
- [Belt](api/belt): immutable collections and extra helpers not available in JavaScript / [Stdlib](api/stdlib). | ||
- [Dom](api/dom): Dom related types and modules. Contains our standardized types used by various userland DOM bindings. | ||
|
||
## Legacy Modules | ||
|
||
The [Js](api/js) module is superseded by [Stdlib](api/stdlib). |
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
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.