Unverified Commit a3af75f9 authored by Tim H's avatar Tim H Committed by GitHub

Fix example and reference version matching syntax

Address documentation issue raised in #2759
parent 16571305
...@@ -7,10 +7,12 @@ This section of the guide covers best practices for `requirements.yaml` files. ...@@ -7,10 +7,12 @@ This section of the guide covers best practices for `requirements.yaml` files.
Where possible, use version ranges instead of pinning to an exact version. The suggested default is to use a patch-level version match: Where possible, use version ranges instead of pinning to an exact version. The suggested default is to use a patch-level version match:
```yaml ```yaml
version: ^1.2.0 version: ~1.2.3
``` ```
This will match version 1.2.0 and any patches to that release (1.2.1, 1.2.999, and so on) This will match version `1.2.3` and any patches to that release. In other words, `~1.2.3` is equivalent to `>= 1.2.3, < 1.3.0`
For the complete version matching syntax, please see the [semver documentation](https://github.com/Masterminds/semver#checking-version-constraints)
### Repository URLs ### Repository URLs
...@@ -42,4 +44,4 @@ tags: ...@@ -42,4 +44,4 @@ tags:
- webaccelerator - webaccelerator
``` ```
This allows a user to turn that feature on and off with one tag. This allows a user to turn that feature on and off with one tag.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment