Skip to content

Comments

Improve safety documentation of the Array trait#9314

Merged
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/more_unsafe_docs
Feb 2, 2026
Merged

Improve safety documentation of the Array trait#9314
alamb merged 1 commit intoapache:mainfrom
alamb:alamb/more_unsafe_docs

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Jan 30, 2026

Which issue does this PR close?

  • Closes #NNN.

Rationale for this change

Per discussion on #9234 (review) @scovich noted that it would be good to point out the core reason it is hard/impossible to implement Array safetly

What changes are included in this PR?

Update the comments on Array to try and capture the thread.

Are these changes tested?

By CI

Are there any user-facing changes?

Docs only, no functional changes

@alamb alamb added the documentation Improvements or additions to documentation label Jan 30, 2026
@github-actions github-actions bot added the arrow Changes to the arrow crate label Jan 30, 2026
@alamb alamb mentioned this pull request Jan 30, 2026
Merged
scovich
scovich approved these changes Jan 30, 2026
View reviewed changes
Copy link
Contributor

@scovich scovich left a comment

Choose a reason for hiding this comment

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

LGTM.

One question: Is it normal for the public docs to reference github pull request comments?

@tustvold
Copy link
Contributor

tustvold commented Jan 30, 2026

One question: Is it normal for the public docs to reference github pull request comments?

We do it in a few places, normally where the history behind a particular design decision is pertinent. I've seen some other libraries do similar things, or to link to tracking issues.

@alamb
Copy link
Contributor Author

alamb commented Jan 30, 2026

One question: Is it normal for the public docs to reference github pull request comments?

We do it in a few places, normally where the history behind a particular design decision is pertinent. I've seen some other libraries do similar things, or to link to tracking issues.

Yeah, I figured there is a bunch of backstory that was hard to fully capture in a paragraph, so I just sort of gave up and added a link back

@alamb alamb merged commit cd08139 into apache:main Feb 2, 2026
26 checks passed
@alamb
Copy link
Contributor Author

alamb commented Feb 2, 2026

Thanks everyone

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

Reviewers

@tustvold tustvold tustvold approved these changes

@scovich scovich scovich approved these changes

+1 more reviewer

@gabotechs gabotechs gabotechs approved these changes

Reviewers whose approvals may not affect merge requirements

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.

4 participants

@alamb @tustvold @scovich @gabotechs