Mention ArrowModule in serialization and ktor sections #306
Conversation
This file contains 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
serras
requested changes
May 16, 2024
content/docs/learn/integrations.md
Outdated
| @@ -78,6 +78,16 @@ The main point of contact between Ktor and Arrow is in | |||
| If you're using kotlinx.serialization, you need no further changes other than | |||
| importing the serializers with `@UseSerializers`. | |||
|
|
|||
| If you want to use Arrow Core types directly as your request or response models, you will need to include the `ArrowModule` in your serializers module: | |||
|
|
|||
| ```kotlin | |||
There was a problem hiding this comment.
Please, do not use ```kotlin here (or in the rest of the file), as it would trigger Knit, but these blocks are not complete Kotlin code.
There was a problem hiding this comment.
I've removed the kotlin tags from the code blocks, and also from the pre-existing blocks for consistency.
They weren't being picked up by knit in the build (at least a ./gradlew knit build passed) as there were no knit patterns in either file, but should one be added at a later it's better to avoid surprises.
serras
approved these changes
May 29, 2024
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.
Given the
ArrowModuleis currently only in the 2.0 branch, I would assume this will need to wait until the 2.0 release. As such, I've also removed the reference toValidatedSerializer.