doc: Clarify the meaning of caret requirements
authorJeehoon Kang <jeehoon.kang@sf.snu.ac.kr>
Thu, 22 Mar 2018 18:25:28 +0000 (03:25 +0900)
committerJeehoon Kang <jeehoon.kang@sf.snu.ac.kr>
Thu, 22 Mar 2018 18:25:30 +0000 (03:25 +0900)
Closes #4910

src/doc/src/reference/specifying-dependencies.md

index 893be3fcefa28d1806afd960aa36bb9f5a548ddf..b7c780a1b35094e71b394f12a5634ba7a96d7506 100644 (file)
@@ -29,10 +29,11 @@ if we had specified `"^0.1.12"`, which is called a caret requirement.
 **Caret requirements** allow SemVer compatible updates to a specified version.
 An update is allowed if the new version number does not modify the left-most
 non-zero digit in the major, minor, patch grouping. In this case, if we ran
-`cargo update -p time`, cargo would update us to version `0.1.13` if it was
-available, but would not update us to `0.2.0`. If instead we had specified the
-version string as `^1.0`, cargo would update to `1.1` but not `2.0`. The version
-`0.0.x` is not considered compatible with any other version.
+`cargo update -p time`, cargo should update us to version `0.1.13` if it is the
+latest `0.1.z` release, but would not update us to `0.2.0`. If instead we had
+specified the version string as `^1.0`, cargo should update to `1.1` if it is
+the latest `1.y` release, but not `2.0`. The version `0.0.x` is not considered
+compatible with any other version.
 
 Here are some more examples of caret requirements and the versions that would
 be allowed with them: