Comments (4)
Hey,
Thanks for the report.
Let me give you a quick overview of what modules docs we would accept:
- Pervasives ... but some functionality in there is actually not recommended for usage, e.g.
string_of_int
(vs.Belt.Int.toString
), etc.
Following modules will not be accepted for following reasons:
Array
... useJs.Array
/Belt.Array
insteadList
,ListLabels
... useBelt.List
insteadString
or evenStr
... useJs.String
insteadSet
... useBelt.Set
(+ its variants) instead- No
Bytes
,Buffer
,Callback
,Digest
,Complex
,Filename
,NativeInt
,Stream
,Random
,Scanf
,Sys
,Unix
. Those are platform dependent and probably won't compile (or at least not nicely) on JS and are too native oriented Stack
... useBelt.MutableStack
insteadSort
... useBelt.SortArray
instead (besides,Sort
is even deprecated in OCaml)- No
Docstrings
,GenLex
,Lexer
,Lexing
,Location
,Longident
,Parse
,Parser
,Parsetree
,Pprintast
,Printast
. These are literally compiler building modules, we don't expose that to our users. - No
Oo
.. ReScript doesn't expose object related syntax features - No
Obj
... this one is a little weird, since it shouldn't be used by any users, not evenObj.magic
- No
Gc
... doesn't look like something we want to expose to JS users Hashtbl
... useBelt.HashMap
(+ variants) instead- No
CamlinternalFormat
,CamlinternalLazy
,CamlinternalMod
,CamlinternalOO
, ... those are internal and probably not useful for our JS users
For OCamlers who still need to use the OCaml related libraries, it's probably better to refer to the actual OCaml 4.06 docs instead. We care mostly about the JS target here, so we recommend our JS optimised modules (which are also partly adapted OCaml stdlib modules). It's most likely also easier to read for them since they are using OCaml syntax.
Following modules I am not sure, but for now it's not accepted:
Queue
.. no idea on how useful this is for JS compilation and if it's optimized for JS usageBigarray
,Int32
/Int64
.. not sure about those.. we should probably offer aBelt.BigInt
at some pointNum
... not sure if this translates to JSSyntaxerr
... not sure if useful for JS contextWeak
... not sure if it translates to JSPrintexn
.. not sure about this one, probably not equivalent toJs.Exn
Arg
... not sure if useful for JS (we have better alternatives in the JS ecosystem)
Hope this makes sense.
Would be happy to review a PR adding Pervasives
, or the Node
module (located in the rescript compiler).
from rescript-lang.org.
Thank you for the explanations. AFAIK Num
is dependent on C bindings so it wouldn't translate anyway (and anyway for big numbers Zarith is recommended and there is a bs-zarith port).
It would make sense to put the above explanations in a documentation page(s) in the API docs section, so that it was more discoverable.
from rescript-lang.org.
It would make sense to put the above explanations in a documentation page(s) in the API docs section, so that it was more discoverable.
Probably good to have on the API overview page, right when you enter the API docs for now?
from rescript-lang.org.
This is superseded by Core which is automatically generated. Everything that is not in Core (or Belt or Js) won't be documented anymore anyways.
from rescript-lang.org.
Related Issues (20)
- Confused by example code in the docmentation HOT 1
- Error during create-rescript-app on Windows 10 PowerShell HOT 2
- Meta: Where to post my issue?
- Syntax Lookup: uncurried functions documentation
- Syntax Lookup: sorting of decorators
- Document that you can do "intrinsic JSX elements"
- Playground stuck on 'Loading...' HOT 1
- "Undocumented" breaking change of array access in v11 HOT 3
- Missing curlies when piping from `await`? HOT 2
- Playground version dropdown rendering as [object object] HOT 2
- Rework module function documentation
- Mention bundling on rescript-std page
- Separator drag not reflecting layout changes after resize in playground HOT 1
- Where can I find all the built-in exception documentation, like Not_found?
- Improve Clarity and Guidance in ReScript Installation and Quickstart Documentation
- Hiding the top nav on mobile devices feels extremely janky HOT 3
- Promise.catch example HOT 5
- Playground - load js files
- Document required ECMAscript version
- Document FORCE_COLOR
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rescript-lang.org.