Skip to content

Commit

Permalink
Add some text for the parameters and remove markdown horizontal break
Browse files Browse the repository at this point in the history
  • Loading branch information
darakian committed Jan 22, 2025
1 parent bec099b commit 20f9b39
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion schema/docs/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Now that we know how to encode version objects, that would be written as:
Type identifier: `semver-2.0.0`
Formally specified here at https://semver.org/spec/v2.0.0.html
`semver-2.0.0` is new type introduced to formally specify usage of semantic versioning.
---

`semver-2.0.0` in its simplest form is a dot separated triple. eg `1.2.3`. The three parts have names with the first being the `MAJOR`, the second being `MINOR` and the third `PATCH`. The [Semantic](https://en.wikipedia.org/wiki/Semantics) meaning of each is described as
1. MAJOR version when you make incompatible API changes
2. MINOR version when you add functionality in a backward compatible manner
Expand All @@ -308,6 +308,8 @@ While the triple can only contain numeric values the `pre-release` and `build` a
A complete definition of this version type can be viewed here
https://semver.org/spec/v2.0.0.html#backusnaur-form-grammar-for-valid-semver-versions

In the interest of simplicity the `semver-2.0.0` version type has two parameters which define a continuous range. `lowerBound` and `upperBound` each must be a valid semver triple with optional pre-release/build extensions.

##### Example

```
Expand Down

0 comments on commit 20f9b39

Please sign in to comment.