Comments (4)
I am hacking on odoc (but not sure when I will arrive at anything good). Markdown support for doc comments /** ... */
will land in reason soon automatically converting it to ocamldoc so it will render in the documentation generator, so it would be good to document the bindings and modules using that even before we have good documentation generation and before markdown supports land.
from rescript-apollo-client.
@jfrolich Markdown support will land in Reason (I assume, at some point), but not in BuckleScript because BuckleScript is not upgrading its refmt version for the foreseeable future.
from rescript-apollo-client.
I hope we can land it in the new syntax as well. It is possible to use your own version of refmt with Bucklescript. Are you sure Bucklescript is not upgrading Reason? That would not be great. It wouldn't be so bad if they would decoupled and released separately though, but shipping an old version by default is not great I guess.
from rescript-apollo-client.
Based on what happened in rescript-lang/rescript-compiler#4271 and then after that the new syntax being publicized, I assume they won't upgrade. And I don't see Markdown docs landing in the new syntax in the near future either (in fact it will be a long road to get to even odoc support for the new syntax, i.e. parity with where Reason syntax is now).
If you want to publish API docs in the near future, your best bet is bsdoc with the current Reason syntax + ocamldoc markup.
from rescript-apollo-client.
Related Issues (20)
- RetryLink and OnError Handling issue HOT 6
- Link headers HOT 2
- EOL for ppx in rescript HOT 3
- Read variables from within the `useMutation`'s `update` function HOT 3
- Nullable field being discarded from mutation HOT 4
- pollInterval option missing from watchQuery
- Incompatibility/Bug with @apollo/client > 3.5.0 HOT 2
- Runtime error with ApolloClient.Utilities.getOperationDefinition function HOT 3
- @apollo/client 3.5 features HOT 1
- Fetching fragment along with other fields HOT 2
- Support `returnPartialData` option after graphql-ppx adds support
- Support for RefetchQueriesFunction HOT 1
- How do I use the InMemoryCache's FieldMergeFunction? HOT 4
- support to nextjs ? HOT 2
- Getting Jest tests to ignore module
- ErrorLink and RetryLLink examples and/or documentation HOT 6
- Is it possible to remove react and rescript-react as dependencies for this to work? HOT 1
- Support rescript 10 HOT 3
- [Discussion] Convert to using optional records? HOT 1
- subscriptions-transport-ws has been deprecated 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-apollo-client.