Skip to content

Conversation

@dkearns
Copy link
Contributor

@dkearns dkearns commented Jul 29, 2016

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?

@masatake
Copy link
Member

main: is enough. One of the purpose adding common prefix is for making the category maintainers' attentions. main: hooks me, @masatake. I strongly believe docs: prefix hooks you:-)
Assignees of github can be used for the same purpose. If one thinks getting an agreement of the category maintainer is requisite, use Assignees. If it is optoinal, use the common prefix.

@masatake
Copy link
Member

I took these field descriptions from the man page. They are capitalized. In this aspect we should make all --list-fields output be capitalized.
In other hand, --list-kinds (and --list-kinds-full) output use lower case. (Basically these output comes from Exuberant-ctags.)

--list-pseudo-tags, which I added, uses lower case. --list-extra output is capitalized. This one comes from man page.

We should apply a unified rule to the output. What we should do?

@dkearns
Copy link
Contributor Author

dkearns commented Jul 29, 2016

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.

@masatake
Copy link
Member

I agree with you that lower-case is better.

We can probably drop "Include" from the start of the descriptions in --list-extra output and "the" from --list-pseudo-tags as well.

Can I ask you to fix these things?

If a --list- option supports --machinable, we can write a test case which verifies the description column of the option output starts lower case. With the test case we can enforuce using lower-case as the start of description to contributors and ourselves.

@dkearns dkearns self-assigned this Jul 29, 2016
@dkearns
Copy link
Contributor Author

dkearns commented Jul 29, 2016

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.
@dkearns dkearns force-pushed the normalise-field-description-capitalisation branch from b218e8f to 06f31c0 Compare August 4, 2016 09:27
@dkearns
Copy link
Contributor Author

dkearns commented Aug 4, 2016

@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 ???"},
Copy link
Contributor Author

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.

Copy link
Member

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.

@dkearns dkearns force-pushed the normalise-field-description-capitalisation branch from 06f31c0 to 298b6d1 Compare August 4, 2016 13:23
@SiegeLord
Copy link
Contributor

Yes, for Rust struct 'fields' is probably the right nomenclature. 'members' typically has OOP connotations. Otherwise, the Rust changes look fine to me.

@dkearns dkearns force-pushed the normalise-field-description-capitalisation branch from 298b6d1 to a028e88 Compare August 4, 2016 16:03
@masatake
Copy link
Member

@dkearns, can I merge the changes?

@masatake masatake self-assigned this Jun 26, 2017
@masatake masatake added this to the M2 for 6.0 milestone Nov 10, 2019
@masatake masatake modified the milestones: M2 for 6.0, M0 for 6.0 Mar 1, 2020
@masatake masatake modified the milestones: M0 for 6.0, M1 for 6.0 Dec 2, 2022
@masatake masatake modified the milestones: 6.1, 6.2 Dec 15, 2022
@masatake masatake modified the milestones: 6.2, 6.3 Mar 13, 2024
@masatake masatake modified the milestones: 6.3, 6.4 Oct 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants