Improve docs for NullArray, new_null_array and new_empty_array #240
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
alamb
added
documentation
alamb
commented
Apr 29, 2021
| @@ -42,12 +25,33 @@ use crate::array::{Array, ArrayData}; | |||
| use crate::datatypes::*; | |||
|
|
|||
| /// An Array where all elements are nulls | |||
| /// | |||
There was a problem hiding this comment.
By moving the description to the struct, the documentation is now on the doc page I would expect (not the module level). Here is what it looks like now:
alamb
force-pushed
the
alamb/better_docs
branch
from
90dfc74 to
cbb9011
Compare
returnString
approved these changes
Apr 29, 2021
Codecov Report
@@ Coverage Diff @@
## master #240 +/- ##
=======================================
Coverage 82.52% 82.52%
=======================================
Files 162 162
Lines 43672 43672
=======================================
Hits 36040 36040
Misses 7632 7632
Continue to review full report at Codecov.
|
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.
Rationale for this change
I have often found myself being confused and searching for this code, so I am hoping to leave some hints to find it. Here is an example where it may have helped: apache/datafusion#223 (though to be honest
new_null_arraymay be newer than the code in datafusionWhat changes are included in this PR?
NullArraypointing atnew_null_arrayand move comments toNullArrayrather than modulenew_null_arrayandnew_empty_arrayAre there any user-facing changes?
Better docs