-
Notifications
You must be signed in to change notification settings - Fork 839
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
minor: add a diagram to docstring for DictionaryArray #1909
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1909 +/- ##
=======================================
Coverage 83.41% 83.41%
=======================================
Files 214 214
Lines 57004 57004
=======================================
+ Hits 47550 47552 +2
+ Misses 9454 9452 -2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Just leave a nit.
DictionaryArray
is always used when you have data with many repeated values. So maybe it is better to give an example with short and fat values
array and long keys
array.
Co-authored-by: Ruihang Xia <[email protected]> Co-authored-by: Jörn Horstmann <[email protected]>
Good point @HaoYang670 -- I updated the diagram in 8cf0dd3 -- what do you think? |
Rationale:
I made a diagram while working with @AssHero on apache/datafusion#2721 which I felt would be generally helpful as the
keys
andvalues
terminology often gets confusing.Changes:
Add some more docstrings to
DictionaryArray
based on apache/datafusion#2721 (comment)