Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for Bitmap #1237

Merged
merged 1 commit into from
Jan 25, 2022
Merged

Improve documentation for Bitmap #1237

merged 1 commit into from
Jan 25, 2022

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jan 24, 2022

Which issue does this PR close?

Re #1233

and related to #1232

Rationale for this change

the len() method on Bitmap is very confusing (it is in terms of bits rather than bytes)

What changes are included in this PR?

  1. Add doc comments for Bitmap::len()
  2. Move some doc comments into the Bitmap struct rather than the module definition

Are there any user-facing changes?

better docs

@alamb alamb added the documentation Improvements or additions to documentation label Jan 24, 2022
@github-actions github-actions bot added the arrow Changes to the arrow crate label Jan 24, 2022
@alamb alamb mentioned this pull request Jan 24, 2022
Merged
@alamb alamb merged commit 7949298 into apache:master Jan 25, 2022
@alamb alamb deleted the alamb/docs branch January 25, 2022 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jimexist jimexist jimexist approved these changes

Assignees
No one assigned
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alamb @jimexist