chore: add docs, part of #37 #6424
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
ByteBaker
force-pushed
the
require_docs
branch
from
e608bd7 to
2d19f6a
Compare
- add pragma `#![warn(missing_docs)]` to `arrow`, `arrow-arith`, `arrow-avro` - add docs to the same to remove lint warnings
ByteBaker
force-pushed
the
require_docs
branch
from
2d19f6a to
ddf19d3
Compare
|
Thanks @ByteBaker -- I also added a reference to #37 to the description of this PR so github links it back to the ticket |
- add pragma `#![warn(missing_docs)]` to `arrow-buffer`, `arrow-cast`, `arrow-csv` - add docs to the same to remove lint warnings
ByteBaker
force-pushed
the
require_docs
branch
from
f58e8f1 to
d6c0479
Compare
|
@alamb I have more work to push, but I'll wait till this one is reviewed, as discussed earlier. |
alamb
approved these changes
Sep 20, 2024
There was a problem hiding this comment.
Thank you very much @ByteBaker -- I think this is a real improvement and a nice example of helping maintain the crate
I left some small suggestions, but nothing I think that would prevent this PR from merging
|
I just updated the PR incorporating the suggestions. Please take a look. |
ByteBaker
force-pushed
the
require_docs
branch
from
4df790a to
4d7a114
Compare
|
🚀 📖 |
|
Thanks @ByteBaker |
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.
Part of #37
#![warn(missing_docs)]to the followingarrowarrow-aritharrow-avroarrow-bufferarrow-castarrow-csv