Closes #458 Run Vale over style guide part 4. #467
Conversation
daobrien
added
the
enhancement
| @@ -38,7 +40,7 @@ | |||
| <term>Ordered lists</term> | |||
| <listitem> | |||
| <para> | |||
| They appear as a numbered list. | |||
| These appear as numbered lists. | |||
There was a problem hiding this comment.
For the sake of translation, "These" should be followed by a noun wherever it occurs.
There was a problem hiding this comment.
Well, this guide is not translated, but ok.
There was a problem hiding this comment.
Yes, but regardless, we should follow our own guidance in "Use of This That These Those" in https://stylepedia.net/style/6.0/#sentence-structure.
There was a problem hiding this comment.
tbh I disagree with that section in the current guide. I don't remember reviewing or ack'ing it (doesn't mean I didn't) but a) it's not a very good title, and b) I don't think following nouns are always required. I think this small section is far to prescriptive, leaving no room for other possibilities, and being a lot more strict than "providing guidelines", which is what the style guide is for in many cases.
In this particular case, the result would be "These lists appear as numbered lists", which is not pretty. This construction also appears many, many times in the current guide. If you think it's an issue that definitely needs addressing then I recommend making it part of the "review the style guide" GH issue.
| In technical content, use “while” only to indicate that many tasks or processes occur at the same time. | ||
| For example, instead of "While most targets use one target portal group (TPG), advanced configurations might define multiple TPGs", write "Although most targets use one target portal group (TPG), advanced configurations might define multiple TPGs". | ||
| In technical content, use "while" only to indicate that many tasks or processes occur at the same time. | ||
| For example, instead of "While most targets use one target portal group (TPG), advanced configurations might define multiple TPGs", write "Although most targets use one target portal group (TPG), advanced configurations might define multiple TPGs." |
There was a problem hiding this comment.
Suggest not to include the period in the quotation, to mirror the comma placement in the previous example.
There was a problem hiding this comment.
I thought that was where they belonged. Did I read it wrong?
There was a problem hiding this comment.
The last example in this sentence could go either way, because it is a complete sentence in itself; however, my overriding preference is to move the punctuation outside the quotation marks, for consistency with the previous example that ends with a comma. A minor point for sure.
No description provided.