daobrien/457 vale check #464
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
daobrien
commented
Feb 3, 2023
daobrien
commented
- Working on Run Vale over the style guide Part 3 #457 Run Vale of the style guide part 3.
- Closes Run Vale over the style guide Part 3 #457 Run Vale over the style guide, part 3.
julian-cable
reviewed
Feb 3, 2023
| @@ -111,17 +116,14 @@ | |||
| <term>number sign</term> | |||
| <listitem> | |||
| <para> | |||
| Generally, use "number sign" to refer to the # character. Alternatively, use "hash" to refer to a hashtag in social media, or to refer to Secure Hash Algorithm (see <xref linkend="sha" />), or when writing exclusively for a European audience. You can instead use "pound sign" when writing exclusively for a North American audience, if "number sign" is not appropriate for the context. | |||
| Generally, use "number sign" to refer to the # character. | |||
| Or, use "hash" to refer to a hashtag in social media, or to refer to Secure Hash Algorithm (see <xref linkend="sha" />), or when writing exclusively for a European audience. | |||
There was a problem hiding this comment.
I know that Microsoft advises otherwise, but I don't much like this word replacement at the start of this sentence, which results in a sentence in the format "Or A, or B, or C".
| @@ -244,10 +249,11 @@ | |||
| <term>open source way</term> | |||
| <listitem> | |||
| <para> | |||
| A phrase that was coined by the Red Hat community and adopted by opensource.com in 2009. It is a reference to an "open source method", as in "Let's develop this project the open source way." | |||
| A phrase that was coined by the Red Hat community and adopted by opensource.com in 2009. | |||
| It is a reference to an "open source method", as in "Let's develop this project the open source way." | |||
There was a problem hiding this comment.
Given our guidance to avoid contractions, we should avoid them here in a quoted example.
| @@ -109,12 +112,11 @@ | |||
| <term>plug-in</term> | |||
| <listitem> | |||
| <para> | |||
| <emphasis>n.</emphasis> Write hyphenated. Do not use "plugin". | |||
| <emphasis>n.</emphasis> Write hyphenated. | |||
| Do not use "plugin". | |||
There was a problem hiding this comment.
Although some product terminology uses "plugin", and the CCS Supplementary Style Guide now defines the unhyphenated form as the standard.
|
Fixed the spurious space. The other comments are outside the scope of this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.