docs: Clarify functionality of SnapshotProduceOperation
#1874
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
Contributor
Author
|
@ZENOTME Your input on this is appreciated! |
…nathanc-n/iceberg-rust into snapshotproduceoperation-docs
Contributor
Author
|
@CTTY @liurenjie1024 I think this can get reviewed by others as well? I've noticed that much of the core functionality isn't sufficiently documented for developers, (ex. ManifestWriter, SnapshotProduceAction, etc.). I think we could open an issue to try to throughly document the different core structs so contributors have an easier time working on the codebase. It could be a good first issue for anybody interested in pushing forward iceberg-rust |
liurenjie1024
approved these changes
Nov 26, 2025
Contributor
liurenjie1024
left a comment
liurenjie1024
left a comment
There was a problem hiding this comment.
Thanks @jonathanc-n for this pr!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which issue does this PR close?
What changes are included in this PR?
While refreshing myself on the internals of iceberg-rust, I felt that
SnapshotproduceOperationshould have documentation to be more clear to anybody who wants to work on Iceberg-rustUse of LLM Clarification
I did use LLM to generate these docs however I reviewed it myself.