Skip to content

ARROW-1416: Clarify memory layout documentation - #998

Closed
fritzo wants to merge 1 commit into
apache:masterfrom
fritzo:patch-1
Closed

ARROW-1416: Clarify memory layout documentation#998
fritzo wants to merge 1 commit into
apache:masterfrom
fritzo:patch-1

Conversation

@fritzo

Copy link
Copy Markdown
Contributor

This PR slightly reduces ambiguity in the array example for null bitmaps. The original example was left/right symmetric; this PR changes the example to break that symmetry. Asymmetry is important since readers who skip the byte endianness section could have interpreted the bitmap buffer in two distinct ways: left-to-right with an offset of 3 (wrong), or right-to-left with zero offset (correct).

This PR slightly reduces ambiguity in the array example for null bitmaps. The original example was left/right symmetric; this PR changes the example to break that symmetry. Asymmetry is important since readers who skip the byte endianness section could have interpreted the bitmap buffer in two distinct ways: left-to-right with an offset of 3 (wrong), or right-to-left with zero offset (correct).
@fritzofritzo changed the title Clarify memory layout documentationARROW-1416: Clarify memory layout documentationAug 27, 2017

@wesmwesm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, thanks! Making the example non-symmetric indeed makes things more clear

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@fritzo@wesm