Improve docs for NullArray, new_null_array and new_empty_array #240
Conversation
alamb
added
documentation
| 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
left a comment
returnString
left a comment
There was a problem hiding this comment.
Looks great! 👍 The note/link to arrow::array::new_null_array is especially handy; I have a poor man's version of this in a few codebases after I looked up NullArray, saw it was an array of the null type, and thought "ok, guess that's not supported".
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.
|
5 participants
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