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.

Sign up for GitHub

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

Jump to bottom

Markdown Header Capitalization Congruence #48

Closed
snuggs opened this issue Nov 8, 2017 · 2 comments
Closed

Markdown Header Capitalization Congruence #48

snuggs opened this issue Nov 8, 2017 · 2 comments

Comments

@snuggs
Copy link
Member

snuggs commented Nov 8, 2017 •
edited

We seem to be mis-aligned with header capitalization.
I didn't quite know what the "right" answer is (if there is even one).

FWIW found a nice "rule-of-thumb" guide that is fairly long in the tooth (but then again so is linguistics).

Noticed @annevk recently went with the "all capital words in header" approach. IIRC there is something about headers being like sentences. For certain I do recall them being without periods.

Example

https://github.com/whatwg/meta/blame/master/GITHUB-TEAMS.md#L1

May seem like a nit now but better to address a match than a forest fire. I would have fixed this up myself but not for me to solely decide without feedback. Please let me know and I'll submit a patch for us ASAP.

🙏
@snuggs
Copy link
Member Author

snuggs commented Nov 8, 2017 •
edited

Perfect example of both cases within a single document. (pun intended). So already noticing cross-repo.

https://github.com/whatwg/html/blob/master/TEAM.md#html-standard-maintainer-guidelines
capture d ecran 2017-11-08 a 04 26 34

@annevk
Copy link
Member

annevk commented Nov 8, 2017

Our rough convention is that titles use "Title Case" and headers use "Sentence case". Indeed, no periods. However, we haven't consistently applied this so far.

@snuggs snuggs mentioned this issue Nov 8, 2017
Merged
@annevk annevk closed this as completed in #50 Nov 9, 2017
annevk pushed a commit that referenced this issue Nov 9, 2017
@snuggs @annevk
Editorial: fix header capitalization congruence
3400d2c 
Fixes #48.
snuggs added a commit to snuggs/wpt that referenced this issue Nov 10, 2017
@snuggs
Editorial: Update README.md
0d693af 
Improve prose for resources (i.e., `testharness.js`).

I have been educating the community on the benefits of aligning testing
with WPT. However, testharness is a little difficult to get head wrapped around
from the feedback I am receiving. Also have recently been doing some prose
updates in documentation over @ WHATWG. I am revisiting the WPT setup process
and believe one should always leave code better than when they saw it.

References:
  - whatwg/meta#48
  - (in particular) whatwg/meta#48 (comment)
@snuggs snuggs mentioned this issue Nov 10, 2017
Merged
gsnedders pushed a commit to web-platform-tests/wpt that referenced this issue Nov 24, 2017
@snuggs @gsnedders
📝Editorial: Update resources/README.md (#8140)
589f2e2 
Improve prose for resources (i.e., `testharness.js`).

I have been educating the community on the benefits of aligning testing
with WPT. However, testharness is a little difficult to get head wrapped around
from the feedback I am receiving. Also have recently been doing some prose
updates in documentation over @ WHATWG. I am revisiting the WPT setup process
and believe one should always leave code better than when they saw it.

References:
  - whatwg/meta#48
  - (in particular) whatwg/meta#48 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@snuggs @annevk