Documentation improvements: Encryption #494
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
adamreeve
requested changes
Jan 20, 2025
There was a problem hiding this comment.
This looks great thanks @jescalada, I've left some mostly minor comments
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
Co-authored-by: Adam Reeve <[email protected]>
….com/jescalada/ParquetSharp into jescalada-api-reference-improvements
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.
This PR adds summaries to public methods and fields in Encryption-related files. Eventually, we want to generate an HTML API reference, so the documentation should be as thorough as possible.
I went through
TestEncryption.cs, checked all the public-facing classes, and documented the methods. For some methods, I used pyarrow documentation as a reference, for others I just used common sense (and Copilot to match existing doc styles). I'm not sure what degree of C# literacy we are expecting (such as explaining or omitting that certain classes must be used withusingkeyword).Please let me know about any inaccuracies/redundancies or how to improve the docs! I'll use the feedback to document some of the larger files more accurately later on (such as the core Reader/Writer classes). Thank you!