Add missing documentation to transforms module #1699
Merged
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
rukai
force-pushed
the
document_transforms_module
branch
2 times, most recently
from
abb9249
to
2580084
Compare
rukai
force-pushed
the
document_transforms_module
branch
from
2580084
to
1afa565
Compare
ronycsdu
approved these changes
Jul 23, 2024
CodSpeed Performance ReportMerging #1699 will not alter performanceComparing Summary
|
justinweng-instaclustr
approved these changes
Jul 23, 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.
The transforms module is a core part of our public API, so it should be well documented.
This PR adds documentation for many missing fields.
I noticed
TransformContextConfig::protocolshould really be namedTransformContextConfig::up_chain_protocolbut I have not renamed it because that would force us into shotover 0.5 so soon after 0.4, so I left a TODO instead.