chore: add docs, part of #37 #6496
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
github-actions
bot
added
parquet
ByteBaker
force-pushed
the
require_docs
branch
from
bd846e4
to
8af4fc3
Compare
- add pragma `#![warn(missing_docs)]` to `parquet` This is the final component in the effort to make Arrow fully-documented. The entire project now generates warning for missing docs, if any. - `arrow-flight`: replace `tonic`'s deprecated `compile_with_config` with suggested method - new deprecation: The following types were not used anywhere and were possibly strays. They've been marked as deprecated and will be removed in future versions. - `parquet::data_types::SliceAsBytesDataType` - `parquet::column::writer::Level`
ByteBaker
force-pushed
the
require_docs
branch
from
8af4fc3
to
333d8bf
Compare
alamb
approved these changes
Oct 2, 2024
There was a problem hiding this comment.
I love it -- thank you @ByteBaker
This is the kind of slog that I think makes the code overall better (and ensures going forward people doc things ❤️ )
🚀
|
I think this PR wins the award for lowest github issue number closed in a long time. 37! |
alamb
added
documentation
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.
Closes #37.
add pragma
#![warn(missing_docs)]toparquetThis is the final component in the effort to make Arrow fully-documented. The entire project now generates warning for missing docs, if any.
arrow-flight: replacetonic's deprecatedcompile_with_configwith suggested methodNew deprecation: The following types were not used anywhere and were possibly strays. They've been marked as deprecated and will be removed in future versions.
parquet::data_types::SliceAsBytesDataTypeparquet::column::writer::Level