-
Notifications
You must be signed in to change notification settings - Fork 645
main: normalise capitalisation of field descriptions #1054
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.
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
base: master
Are you sure you want to change the base?
main: normalise capitalisation of field descriptions #1054
Conversation
|
|
|
I took these field descriptions from the man page. They are capitalized. In this aspect we should make all
We should apply a unified rule to the output. What we should do? |
|
Flip a coin? :) I don't think it really matters and the command output doesn't have to be the the same as the man page which can include more elaborate descriptions. Since the command output descriptions are more often than not fragments rather than proper sentences how about we go with lower-case for all command output? It looks a bit nicer to me. We can probably drop "Include" from the start of the descriptions in --list-extra output and "the" from --list-pseudo-tags as well. |
|
I agree with you that lower-case is better.
Can I ask you to fix these things? If a |
|
OK, I'll finish this. |
Description strings for fields, kinds, pseudo-tags, etc., should generally be lowercase by may be incidentally capitalised when starting with proper names or acronyms.
b218e8f to
06f31c0
Compare
|
@SiegeLord Could you please check the changes to Rust's kind descriptions make sense and that I haven't introduced any subtle errors? From the Rust docs I guess "struct fields" is more appropriate than "struct members"? @Twinside, likewise, could you do the same for the OCaml and Objective-C changes? Thanks. |
| {TRUE, 'r', "RecordField", "record fields"}, | ||
| {TRUE, 'e', "Exception", "exceptions"}, | ||
| {TRUE, 'V', "value", "value ???"}, | ||
| {TRUE, 'B', "beginEnd", "begin end ???"}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should these last two be removed? They don't appear to be used yet so are a bit confusing in the kinds output.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm very sorry to be late. Ideally V and B are used internally. I should remove them in the future. However, the knowledges about both OCaml language and OCaml parser are needed to remove.
06f31c0 to
298b6d1
Compare
|
Yes, for Rust struct 'fields' is probably the right nomenclature. 'members' typically has OOP connotations. Otherwise, the Rust changes look fine to me. |
298b6d1 to
a028e88
Compare
|
@dkearns, can I merge the changes? |
This just caught my eye. Capitalised descriptions outnumbered those that weren't so I went with that.
I'm not sure if the commit prefix needs to be more elaborate than "main:" and reference the touched parsers?