Skip to content

Commit e7596aa

Browse files
Fix spelling in README
1 parent 2f39fdc commit e7596aa

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ If you are looking for a command line tool for version comparisons please see
1818

1919
## Package Versions
2020

21-
Note, import `github.com/github.com/Masterminds/semver/v3` to use the latest version.
21+
Note, import `github.com/Masterminds/semver/v3` to use the latest version.
2222

2323
There are three major versions fo the `semver` package.
2424

@@ -80,12 +80,12 @@ There are two methods for comparing versions. One uses comparison methods on
8080
differences to notes between these two methods of comparison.
8181

8282
1. When two versions are compared using functions such as `Compare`, `LessThan`,
83-
and others it will follow the specification and always include prereleases
83+
and others it will follow the specification and always include pre-releases
8484
within the comparison. It will provide an answer that is valid with the
8585
comparison section of the spec at https://semver.org/#spec-item-11
8686
2. When constraint checking is used for checks or validation it will follow a
8787
different set of rules that are common for ranges with tools like npm/js
88-
and Rust/Cargo. This includes considering prereleases to be invalid if the
88+
and Rust/Cargo. This includes considering pre-releases to be invalid if the
8989
ranges does not include one. If you want to have it include pre-releases a
9090
simple solution is to include `-0` in your range.
9191
3. Constraint ranges can have some complex rules including the shorthand use of
@@ -113,7 +113,7 @@ v, err := semver.NewVersion("1.3")
113113
if err != nil {
114114
// Handle version not being parsable.
115115
}
116-
// Check if the version meets the constraints. The a variable will be true.
116+
// Check if the version meets the constraints. The variable a will be true.
117117
a := c.Check(v)
118118
```
119119

@@ -137,20 +137,20 @@ The basic comparisons are:
137137
### Working With Prerelease Versions
138138

139139
Pre-releases, for those not familiar with them, are used for software releases
140-
prior to stable or generally available releases. Examples of prereleases include
141-
development, alpha, beta, and release candidate releases. A prerelease may be
140+
prior to stable or generally available releases. Examples of pre-releases include
141+
development, alpha, beta, and release candidate releases. A pre-release may be
142142
a version such as `1.2.3-beta.1` while the stable release would be `1.2.3`. In the
143-
order of precedence, prereleases come before their associated releases. In this
143+
order of precedence, pre-releases come before their associated releases. In this
144144
example `1.2.3-beta.1 < 1.2.3`.
145145

146-
According to the Semantic Version specification prereleases may not be
146+
According to the Semantic Version specification, pre-releases may not be
147147
API compliant with their release counterpart. It says,
148148

149149
> A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version.
150150
151-
SemVer comparisons using constraints without a prerelease comparator will skip
152-
prerelease versions. For example, `>=1.2.3` will skip prereleases when looking
153-
at a list of releases while `>=1.2.3-0` will evaluate and find prereleases.
151+
SemVer's comparisons using constraints without a pre-release comparator will skip
152+
pre-release versions. For example, `>=1.2.3` will skip pre-releases when looking
153+
at a list of releases while `>=1.2.3-0` will evaluate and find pre-releases.
154154

155155
The reason for the `0` as a pre-release version in the example comparison is
156156
because pre-releases can only contain ASCII alphanumerics and hyphens (along with

0 commit comments

Comments
 (0)