Skip to content

Commit 3fbee17

Browse files
authored
Style guide: Add advice for release number 'or later' (#57298)
1 parent 6fe837a commit 3fbee17

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

content/contributing/style-guide-and-content-model/style-guide.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ For presenting keyboard shortcuts, follow the [Microsoft Style Guide](https://do
551551

552552
### Usage highlights
553553

554-
Below are some usage highlights for how we present keyboard shortcuts in our documentation:
554+
Here are some usage highlights for how we present keyboard shortcuts in our documentation:
555555

556556
* The basic syntax is to show keys with `+` between key combinations, without any spaces.
557557

@@ -592,7 +592,7 @@ Below are some usage highlights for how we present keyboard shortcuts in our doc
592592
593593
Do not create reusables for license attributions. We must use the exact license a project is licensed under, so any attributions must be accurately written for the articles that they appear in.
594594
595-
If you are unsure of the legality of reusing any content, contact legal. If you are adding content with a license that is not listed below, you must receive a legal review before you can publish the content.
595+
If you are unsure of the legality of reusing any content, contact legal. If you are adding content with a license that is not listed here, you must receive a legal review before you can publish the content.
596596
597597
### Attributing MIT-licensed content
598598
@@ -1270,6 +1270,14 @@ To signal to readers that you've added or changed a note, or to indicate the pub
12701270
12711271
To signal that we have removed a release note, add an "Errata" section detailing which note you removed and (if relevant) which version the removed note actually pertains to. See [Writing errata](#writing-errata).
12721272
1273+
## Release references
1274+
1275+
When referring to a range of releases starting from a particular release, use "or later."
1276+
1277+
* **Use:** "release 0.41.0 or later"
1278+
* **Avoid:** "release 0.41.0 or above"
1279+
* **Avoid:** "release 0.41.0 or greater"
1280+
12731281
## Reusables and variables
12741282
12751283
Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the [data directory](https://github.com/github/docs/tree/main/data) in the [`github/docs`](https://github.com/github/docs) repository, [Creating reusable content](/contributing/writing-for-github-docs/creating-reusable-content), and the [Product names](#product-names) section of this document.

0 commit comments

Comments
 (0)