Skip to content
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

Capitalization of category and value names #4

Open
HactarCE opened this issue Oct 6, 2019 · 4 comments
Open

Capitalization of category and value names #4

HactarCE opened this issue Oct 6, 2019 · 4 comments

Comments

@HactarCE
Copy link
Contributor

HactarCE commented Oct 6, 2019

It was initially brought up here that many Ithkuilic category wildly differ from the actual definition of their namesake; Context is a classic example. I propose that we define a capitalization convention for this documentation.

JQ has been somewhat inconsistent between Capitalization and FULL UPPERCASING of category and value names. The convention that I have used in the past is to uppercase category and value names when used on their own (e.g. "the Case of this formative" or "the definition of Thematic is ...") and capitalize the value (but not category) when both are included (e.g. "this formative carries Thematic case").

We could go with FULL UPPERCASING when referring to the value within its own documentation (e.g. "The ATTRIBUTIVE case is similar to the Affective case ..."), which serves to differentiate the value being defined from others.

What should the convention be here?

@porpoiseless
Copy link
Collaborator

Definitely important to make it stand out when the category name is being used. They say you should never go FULL UPPERCASE, but let's go FULL UPPERCASE!

@HactarCE
Copy link
Contributor Author

HactarCE commented Oct 14, 2019

Full uppercase for everything? It looks like Quijada uses full uppercase for the names of values, but merely capitalizes categories. And in titles, he only capitalizes value names. Adopting the same scheme here would be very challenging, since links would automatically assume the text of their destination's heading (which may merely be capitalized).

Additionally, I personally strongly dislike the look of FULL UPPERCASE, and it is annoying to type.

At the very least, I don't think that this issue should be closed yet.

@porpoiseless porpoiseless reopened this Oct 14, 2019
@porpoiseless
Copy link
Collaborator

I meant to use FULL UPPERCASE for the name of category X in the full description of category X. Here for example. Really no problem to change if you dislike it though.

@HactarCE
Copy link
Contributor Author

Alright, I'm OK with that. (No links, no problem!) For all other cases, I guess we'll use the capitalization scheme is used in headings: first letter of first word capitalized, and the rest lowercase?

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

No branches or pull requests

2 participants