Comments (5)
The point here is that interpolated strings have different behavour when escpaing special characters
let foo = `foo
bar`
is being parsed into "foo\\nbar"
. this is not suppored by ocaml doc parser. @IwanKaramazow can confirm if this is expected behaviour.
it should be ok using normal strings ""
.
Note: note that ocamldoc is not supported as first class in rescript, in future this will improve.
from rescript-vscode.
But using normal strings won't work with unicode?
from rescript-vscode.
Hmm, that's a specific use case, maybe @IwanKaramazow can help.
But again, ocaml doc is not supported properly in rescript and there's a plan for a friendly first-class in-code doc support for rescript.
from rescript-vscode.
Ok, so to summarize so far:
- Multiline doc strings will work fine with regular strings
""
- Multiline interpolation won't
@ocaml.doc
isn't necessarily supported (although it does seem to work). At some point there might be a first class code doc support in ReScript itself
So, as of now it'll work as long as you don't need unicode in your doc strings. Does that sound about right?
from rescript-vscode.
I'm closing this since I got my question answered.
from rescript-vscode.
Related Issues (20)
- Using "rename symbol" on labelled argument breaks HOT 3
- Using "rename symbol" on module type is broken
- tools linux binary dynamically links musl HOT 12
- docgen id is ambiguous HOT 2
- docgen ignores modules with annotated types HOT 2
- docgen should name module type for explicitly annotated module type HOT 3
- LSP autocompletion not offering module type in the same file
- docgen does not distinguish between module and functor
- GitHub action for automatic release process is deprecated
- Incremental type checking not working on a specific project HOT 5
- Explore adding additional completion in rescript.json
- replace failwith with %todo HOT 1
- `"include": "#storage"` does not exist
- Wrong hover content when there is `include` above a value
- The Config of SemanticTokenScopes has affected other languages.
- Semantic token: let keyword HOT 2
- Can't find ReScript binary
- No errors shown anymore after clean & rebuild HOT 7
- Attributes not included in reanalyze locations HOT 2
- @react.component props record in externals not automatically marked as live HOT 1
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-vscode.