Doc: documentation overhaul, cljdoc compatibility, version bumps #9
Conversation
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
- Updated dependencies - Adapter libraries now depend on the core SDK. There is no longer a need to explicitly depend on the core SDK. - New articles have been added to the `doc` directory - Several docstrings have been added / updated - New babashka tasks to help running a local cljdoc instance and ingesting the docs locally - The build process now adds libraries interdependencies automatically - libraries are now in a libraries directory instead of the root of the project - Malli schemas have been split into 3 libraries
| @@ -13,14 +13,14 @@ | |||
| - [[content-encoding]] | |||
|
|
|||
| With this 3 keys we can control buffering aspects of our SSE connction and | |||
| @@ -25,7 +27,10 @@ | |||
|
|
|||
|
|
|||
|
|
|||
| (defn ->sse-gen [& _] | |||
| (defn ->sse-gen | |||
| "Returns a SSEGenerator that whose [[starfederation.datastar.clojure.protocols/send-event!]] implementation doesn't | |||
There was a problem hiding this comment.
drop the "that"
Maybe rewrite as 'Returns an SSEGenerator whose [[starfederation.datastar.clojure.protocols/send-event!]] implementation is a stub that returns the event string instead of sending it.'
| `:body` of the request) | ||
|
|
||
| We do not impose any json parsing library. This means that you need to bring | ||
| your own to parse the returned valuue into Clojure data. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docdirectory