ARROW-12000: [Documentation] Add note about deviation from style guide on struct/classes#9739
Closed
westonpace wants to merge 2 commits intoapache:masterfrom
Closed
ARROW-12000: [Documentation] Add note about deviation from style guide on struct/classes#9739westonpace wants to merge 2 commits intoapache:masterfrom
westonpace wants to merge 2 commits intoapache:masterfrom
Conversation
Member
westonpace
commented
Mar 17, 2021
westonpace
commented
…ructs where convenient
dianaclarke
reviewed
Mar 17, 2021
| * For internal types (not in public headers) it is ok to use structs for | ||
| convenience (e.g. list initialization) if access control is not needed | ||
| (e.g. no public access to a nested type) even if the struct has | ||
| state/invaiants |
Contributor
There was a problem hiding this comment.
s/invaiants/invariants/ ?
Member
|
This doesn't seem exact. We have
|
Member
Author
|
FileInfo is an interesting case. It actually does use access control and has mutable state. Wes' rationale covers the public headers case but I also want to say something about private headers. I'll try again. |
Member
Author
|
@pitrou Does this wording seem better? |
Member
|
Yes, it reads good to me. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.