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

Fixed capitalization of subsections in chapter 7. Response #981

Closed
wants to merge 1 commit into from
Closed

Fixed capitalization of subsections in chapter 7. Response #981

wants to merge 1 commit into from

Conversation

rivantsov
Copy link
Contributor

Changed capitalization of subsections to first-cap style like in the rest of the doc

@netlify
Copy link

netlify bot commented Aug 3, 2022

Deploy Preview for graphql-spec-draft ready!

Name Link
🔨 Latest commit 4e7dff1
🔍 Latest deploy log https://app.netlify.com/sites/graphql-spec-draft/deploys/62ea03f38505940008f09aa1
😎 Deploy Preview https://deploy-preview-981--graphql-spec-draft.netlify.app/draft
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

benjie
benjie previously approved these changes Aug 3, 2022
@benjie benjie added the ✏️ Editorial PR is non-normative or does not influence implementation label Aug 3, 2022
@benjie
Copy link
Member

benjie commented Dec 8, 2022

Notes from the Dec APAC WG: thanks for spotting this inconsistency. We need to decide on a style guide for the spec and then uniformly apply it across the entire document for all **...** titles. If title case, we should have a concrete style guide such as the Chicago style guide or the New York Times style guide so we know which words to capitalise and which not to.

@benjie
Copy link
Member

benjie commented Dec 8, 2022

I've used:

$ grep -hr '^\*\*.*\*\*$' . | sort -u

To pull out all the titles of this format. They roughly sort into:

Title case

Seems like deliberate title case.

**Circular References**
**Coercing Results**
**Conforming Algorithms**
**Delivery Agnostic**
**Escape Sequences**
**Explanatory Text**
**Field Ordering**
**First Class Documentation**
**Formal Specification**
**Interfaces Implementing Interfaces**
**Lexical Analysis & Syntactic Parse**
**Lookahead Restrictions**
**Non-Normative Portions**
**Parameterized Grammar Productions**
**Static Semantics**
**Supporting Subscriptions at Scale**

Title case via keywords

Seems like title case but could just be that capitalised keywords such as Non-Null Fields are used, having the effect of title case.

**Block Strings**
**Built-in Directives**
**Built-in Scalars**
**Custom Directives**
**Custom Scalars**
**Default Root Operation Type Names**
**Errors and Non-Null Fields**
**Event Streams**
**Input Coercion**
**Input Object**
**Merging Selection Sets**
**Nullable vs. Optional**
**Optionality and Lists**
**Reserved Names**
**Resolving Abstract Types**
**Result Coercion and Serialization**
**Result Coercion**
**Schema Introspection Schema**
**Schema Validation**
**Type Validation**

Sentence case

Unambiguously sentence case.

**Allowing optional variables when default values exist**
**Arguments are unordered**
**Byte order mark**
**Copyright notice**
**Directive order is significant**
**Error result format**
**Field errors**
**Input object fields are unordered**
**Query shorthand**
**Request errors**
**Type system evolution**

Sentence case except keywords

Capitalisation of keywords (Spreads, Interface Scope, Fragments) but sentence case for the rest.

**Interface Spreads in implemented Interface Scope**
**Variable use within Fragments**

Indeterminate

Single words don't sway one way or the other.

**Conformance**
**Constraints**
**Deprecation**
**Enum**
**Examples**
**Interface**
**Introduction**
**Licensing**
**List**
**Non-Null**
**Object**
**Scalar**
**Semantics**
**Union**
**Validation**

One more thing...

There's inconsistency on whether we should capitalise after a hyphen; e.g. we have Built-in but Non-Null. Again this is something a style guide should dictate.

@benjie
Copy link
Member

benjie commented Dec 8, 2022

After a deeper analysis, I have proposed this: #1003

@rivantsov
Copy link
Contributor Author

Perfect!

@rivantsov
Copy link
Contributor Author

Since the new style guide sets the Title case for headings, this PR fixes the remaining non-conforming headers to Title case, so it is ready to merge.

@benjie benjie dismissed their stale review January 5, 2023 19:28

Replaced by #1003?

@benjie benjie closed this in #1003 Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✏️ Editorial PR is non-normative or does not influence implementation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants