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

Use sentence case throughout titles and headings #2223

Closed
JJ opened this issue Jul 27, 2018 · 5 comments
Closed

Use sentence case throughout titles and headings #2223

JJ opened this issue Jul 27, 2018 · 5 comments
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) good first issue If you want to dive in, this would be a good place to start help wanted We need some help here meta RFCs, general discussion, writing style, repository organization, etc.

Comments

@JJ
Copy link
Contributor

JJ commented Jul 27, 2018

The problem

This is now in the style guide, although hidden under the reference to the Wikipedia manual of style.

Suggestions

Sentence case implies that only the first letter of a title or heading is to be capitalized. This needs to be done consistently throughout all the documentation. Done already for #1945 (which is closed), but there are zillions of other documents with the same problem.

@JJ JJ added big Issue consisting of many subissues help wanted We need some help here good first issue If you want to dive in, this would be a good place to start docs Documentation issue (primary issue type) meta RFCs, general discussion, writing style, repository organization, etc. labels Jul 27, 2018
JJ referenced this issue Jul 27, 2018
Reflow, elimination of capitals and stuff, but also eliminates the Try
category (refs #1410) and the incorrect indexing of Try. This would
close the nicely numbered 2222 issue: closes #2222
JJ added a commit that referenced this issue Jul 28, 2018
It actually started with #1566, trying to improve the description of
constants. However, while I was at it, I noticed references to
Synopsis, so I changed a few of them working on #2225.
This also fixes #2226 and, in fact, has generated rakudo/rakudo#2141
for a command line flag that was referenced here and was actually
working on Perl 6 (undocumented). Of course, there was a bit of #2223
and a bit of reflow.

I guess now it's back to work on #1566 or maybe #2225.
JJ added a commit that referenced this issue Jul 30, 2018
@MorayJ
Copy link
Contributor

MorayJ commented Aug 2, 2018

What would count as proper names when doing this? So from NativeCall.pod6 we've got:

Basic use of Pointers

and:

Library Paths and Names

and in numerics.pod6:

Printing Rationals

and:

Available Allomorphs

Should types be considered proper names?

Perl 6 is a proper name as that's in the guide, I think.

Edit Asking because I'm happy to help rather than just to discuss and want to check I'm going to be going in the right direction

@MorayJ
Copy link
Contributor

MorayJ commented Aug 3, 2018

I've been looking at this a bit more and proposing adding this, or something similar, to the style guide:

It would mean changing all of 'method method-name' to 'Method method-name' in the Types section (eg https://docs.perl6.org/type/Any

That has been so methodical, I'm not sure that there's not a different rule being followed, which could lead to friction.

I'm happy to take this on, but I want to make sure I'm not going to end up in editing tennis with someone...


All titles, subtitles and headers (=TITLE, =SUBTITLE, =head[1..Inf]) should be written in sentence case.

Sentence case has a capitalised first word with all following words fully lowercased, except for words which are proper nouns.

If a word is a proper noun, it should be written with the expected casing.

A proper noun is a noun that, in its primary application, refers to a unique entity.

Example: "Difference between methods and functions".

Methods and functions are common nouns and so do not have leading upper case letters unless at the start of a sentence.

Example: "What is Perl 6 and what is Rakudo Star?"

Perl 6 and Rakudo Star are unique entities and so are proper nouns.

Examples of proper nouns:

The names of most computer languages (Perl 5, Perl 6, Python, Lisp...)

The names of people (Larry Wall, Guido van Rossum...)

Functions, attributes, routines and methods whose signature has a specific letter casing.

Example: "Method ACCEPTS"

Example: "Method Str"

Don't use function, attribute, routine or method names as the first word in any headline.

Example: "Add - a method" # WRONG! Don't use this as a headline as the sentence case rule has changed it

Example: "Method add" # RIGHT! It's clear that the method is called 'add'

Titles, subtitles and headers should not end in a full-stop/period. Ideally they should not end with question marks or exclamation marks either.


@JJ
Copy link
Contributor Author

JJ commented Aug 5, 2018

In the case of method, it's also the name of a type declaration, method. So it makes sense to keep it in lowercase.

@MorayJ
Copy link
Contributor

MorayJ commented Aug 5, 2018

Ok, great. That's me thinking out loud to make sure I don't go off on a huge tangent...I'll do some of the 'Language docs that seem fairly clear cut.

@JJ
Copy link
Contributor Author

JJ commented Aug 6, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
big Issue consisting of many subissues docs Documentation issue (primary issue type) good first issue If you want to dive in, this would be a good place to start help wanted We need some help here meta RFCs, general discussion, writing style, repository organization, etc.
Projects
None yet
Development

No branches or pull requests

2 participants