Clarify Kotlin and Scala API descriptions - #46
Merged
Merged
Conversation
why: Reference indexes need descriptions of what each handle does and which resources callers own. Internal narration and empty summaries hid those contracts. what: - Describe Kotlin handles, builders, execution policy, and query fields. - Document Cats Effect handle ownership and live-server failure access. - Give generated Scala field objects a summary for filtering queries. Validation: Kotlin, direct Scala, and Cats Effect check tasks pass, including native documentation generation. ScalaFieldGeneratorTest passes.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The Kotlin and Scala reference indexes contain empty summaries and descriptions of implementation details. Describe the public handles, builders, query fields, resource ownership, and live-server failure access at their source declarations so both native docs and libtmux.org receive the same text.
Validation: Kotlin, direct Scala, and Cats Effect
checktasks pass, including documentation generation. The Scala field generator tests pass. This changes documentation only.