chore: add docs, part of #37 #6433
Merged
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
- add pragma `#![warn(missing_docs)]` to the following - `arrow-array` - `arrow-cast` - `arrow-csv` - `arrow-data` - `arrow-json` - `arrow-ord` - `arrow-pyarrow-integration-testing` - `arrow-row` - `arrow-schema` - `arrow-select` - `arrow-string` - `arrow` - `parquet_derive` - add docs to those that generated lint warnings - Remove `bitflags` workaround in `arrow-schema` At some point, a change in `bitflags v2.3.0` had started generating lint warnings in `arrow-schema`, This was handled using a [workaround](apache#4233) [Issue](bitflags/bitflags#356) `bitflags v2.3.1` fixed the issue hence the workaround is no longer needed.
ByteBaker
force-pushed
the
require_docs
branch
from
c2f93d3 to
feb6d17
Compare
Contributor
Author
|
@alamb for your perusal. |
alamb
reviewed
Sep 21, 2024
Contributor
alamb
left a comment
alamb
left a comment
There was a problem hiding this comment.
Other than the one comment about safety this PR is amazing. Thank you @ByteBaker
Contributor
Author
|
Updated the PR. |
Contributor
|
🚀 |
Contributor
|
Thanks again |
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.
add pragma
#![warn(missing_docs)]to the followingarrow-arrayarrow-castarrow-csvarrow-dataarrow-jsonarrow-ordarrow-pyarrow-integration-testingarrow-rowarrow-schemaarrow-selectarrow-stringarrowparquet_deriveadd docs to those that generated lint warnings
Remove
bitflagsworkaround inarrow-schema. At some point, a change inbitflags v2.3.0had started generating lint warnings inarrow-schema. This was handled using a workaround. Here is the original issue.bitflags v2.3.1fixed the issue hence the workaround is no longer needed.