You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,23 +12,23 @@ We're proposing a new, experimental drop-in standard library intended to solve a
12
12
13
13
In practice, the proposed standard library is a fusion of `rescript-js`, `rescript-promise`, and `Belt` - all battle tested and well liked, with a few minor additions sprinkled in. So while we're calling this a new standard library, the parts it's made up of isn't new.
14
14
15
-
It ships as a separate package, so you can try it out and start migrating to it if you want at your convenience. Eventually, if the community likes it and it stands the test of time, it'll might its way into the compiler. And, at that point it would replace the current `Js` namespace.
15
+
It ships as a separate package, so you can try it out and start migrating to it if you want at your convenience. Eventually, if the community likes it and it stands the test of time, it might make its way into the compiler. And, at that point it would replace the current `Js` namespace.
16
16
17
-
We don't anticipate nor plan for larger changes to any of the API:s, but please beware_changes may still happen_ as this project stabilizes. We're of course also interested in the community's feedback on the APIs.
17
+
We don't anticipate nor plan for larger changes to any of the APIs, but please be aware that_changes may still happen_ as this project stabilizes. We're of course also interested in the community's feedback on the APIs.
18
18
19
19
## Guiding principles
20
20
21
21
We've been following a few guiding principles as we developed this:
22
22
23
-
- Familiarity for JavaScript developers. Let APIs follow their JS equivalents as much as possible, and where there's new APIs that don't exist in the JS standard library, follow a naming and layout that we think will feel familiar to a JS developer. Example: `Belt.Array.keepMap` is included in the `Array` module, but here renamed to `Array.filterMap` to be more familiar to JS developers.
23
+
- Familiarity for JavaScript developers. Let APIs follow their JS equivalents as much as possible, and where there are new APIs that don't exist in the JS standard library, follow a naming and layout that we think will feel familiar to a JS developer. Example: `Belt.Array.keepMap` is included in the `Array` module, but here renamed to `Array.filterMap` to be more familiar to JS developers.
24
24
- Focus on zero cost APIs, but prioritize quality. Sometimes a small bit of runtime is required for the API to be as good as it can be.
25
25
- Effortless inference is important here. Choose APIs where inference just works. Example: `Belt.Array.reduce` is included instead of `Js.Array2.reduce`, because the `Belt` version's inference is better than the `Js.Array2` version.
26
26
27
27
## Acknowledgements
28
28
29
-
-@bloodyowl + contributors to `rescript-js` are the people who've done the heavy lifting here, since this stdlib is based heavily on `rescript-js`.
29
+
-[@bloodyowl](https://github.com/bloodyowl) + contributors to `rescript-js` are the people who've done the heavy lifting here, since this stdlib is based heavily on `rescript-js`.
30
30
- Also a shout out to the authors of `Belt`, as a few key things have been incorporated directly from `Belt`.
31
-
- Patrick (@ryyppy) for his work on `rescript-promise`, which is fully inlined into the stdlib.
31
+
- Patrick ([@ryyppy](https://github.com/ryyppy)) for his work on `rescript-promise`, which is fully inlined into the stdlib.
32
32
33
33
## Installation
34
34
@@ -98,7 +98,7 @@ open OCamlCompat
98
98
99
99
## Differences to `rescript-js`
100
100
101
-
This standard library is based on `rescript-js`, but with the tweaks and modifications listed below. There are also no uncurried versions of anything in the standard library. This is because this will ship at the same time (or if anything, later) as _uncurried by default_, which will remove the need for explicit uncurried functions.
101
+
This standard library is based on `rescript-js`, but with the tweaks and modifications listed below. There are also no uncurried versions of anything in the standard library. This is because _uncurried by default_ will be coming soon in ReScript 11, which will remove the need for explicitly uncurried functions.
Copy file name to clipboardExpand all lines: proposed_forum_post.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
# [ANN] ReScript Core - a new, batteries included drop-in standard library
4
4
5
-
ReScript core is a new drop-in standard library, intended to be familiar for JavaScript developers and rich enough that you don't need to reach for anything else for typical ReScript development.
5
+
ReScript Core is a new drop-in standard library, intended to be familiar for JavaScript developers and rich enough that you don't need to reach for anything else for typical ReScript development.
6
6
7
7
It's designed to replace the usage of the current `Js` namespace as well as the OCaml pervasives (global `Array`, `List` etc). `Belt` remains unchanged. This is going to clear up the current standard library situation, which can be quite confusing.
8
8
@@ -12,7 +12,7 @@ Check out the [repository for the package here](https://github.com/rescript-asso
12
12
13
13
## Acknowledgements
14
14
15
-
First thing's first - a huge thanks to @bloodyowl and the rest of the contributors to `rescript-js`. This standard library is heavily based on `rescript-js`. Thank you for your great work!
15
+
First thing's first - a huge thanks to [@bloodyowl](https://github.com/bloodyowl) and the rest of the contributors to `rescript-js`. This standard library is heavily based on `rescript-js`. Thank you for your great work!
16
16
17
17
## What does it look like?
18
18
@@ -85,13 +85,13 @@ However, removing it wouldn't happen in the near future. It would live on in its
85
85
86
86
## Migration
87
87
88
-
We'll be supplying some basic utilities to ease migration, making most of it automatic. There will however be some manual work involved, but we are going to focus on allowing migration to be gradual. There are more details on [_migrating here_](https://github.com/rescript-association/rescript-core#migration).
88
+
We'll be supplying some basic utilities to ease migration, making most of it automatic. There will however be some manual work involved, but we are going to focus on allowing migration to be gradual. There are more details on migrating [_here_](https://github.com/rescript-association/rescript-core#migration).
89
89
90
90
## Documentation (we need your help!)
91
91
92
92
As the initial version of the standard library ships as its own package, it'll lack both some of the docstrings in the code, as well as actual documentation. This will be fixed continuously.
93
93
94
-
If you're interested, **your help is much wanted**. We'd some love help crafting proper docstrings for the parts of the standard library that does not already have them. We'll get back here with more details on how you can help soon.
94
+
If you're interested, **your help is much wanted**. We'd love some help crafting proper docstrings for the parts of the standard library that do not already have them. We'll get back here with more details on how you can help soon.
0 commit comments