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
Comments
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.
What would count as proper names when doing this? So from NativeCall.pod6 we've got:
and:
and in numerics.pod6:
and:
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 |
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. |
In the case of method, it's also the name of a type declaration, |
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. |
Thanks!
|
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.
The text was updated successfully, but these errors were encountered: