MINOR: [Format] Schema.fbs grammar -- improve Map key/value field docs readability #45024
Conversation
This file contains 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
kou
changed the title
kou
reviewed
Dec 18, 2024
| /// has two children: key type and the second the value type. The names of the | ||
| /// child fields may be respectively "entries", "key", and "value", but this is | ||
| /// not enforced. | ||
| /// has two children: the first of the key type and second of the value type. |
There was a problem hiding this comment.
I'm not good at English but we don't need one more the?
Suggested change
| /// has two children: the first of the key type and second of the value type. | |
| /// has two children: the first of the key type and the second of the value type. |
There was a problem hiding this comment.
It works grammatically either way, but the extra "the" isn't strictly necessary. Definite articles often need not be repeated in lists. I, personally, prefer the shorter form but defer to maintainers.
See https://english.stackexchange.com/questions/178767/definite-article-repetition-in-lists for a spot of context.
There was a problem hiding this comment.
OK. I'll merge this PR in the next week if nobody objects this PR.
github-actions
bot
added
awaiting changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Rationale for this change
To improve a comment.
What changes are included in this PR?
Improvement to the Map key/value field docs readability.
Are these changes tested?
N/A
Are there any user-facing changes?
No