aboutsummaryrefslogtreecommitdiff
path: root/docs/versions_doc.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versions_doc.md')
-rwxr-xr-xdocs/versions_doc.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/docs/versions_doc.md b/docs/versions_doc.md
index 83ee7a7..8986737 100755
--- a/docs/versions_doc.md
+++ b/docs/versions_doc.md
@@ -2,7 +2,7 @@
Skylib module containing functions for checking Bazel versions.
-<a id="#versions.get"></a>
+<a id="versions.get"></a>
## versions.get
@@ -14,7 +14,7 @@ Returns the current Bazel version
-<a id="#versions.parse"></a>
+<a id="versions.parse"></a>
## versions.parse
@@ -24,7 +24,10 @@ versions.parse(<a href="#versions.parse-bazel_version">bazel_version</a>)
Parses a version string into a 3-tuple of ints
-int tuples can be compared directly using binary operators (<, >).
+int tuples can be compared directly using binary operators (&lt;, &gt;).
+
+For a development build of Bazel, this returns an unspecified version tuple
+that compares higher than any released version.
**PARAMETERS**
@@ -39,7 +42,7 @@ int tuples can be compared directly using binary operators (<, >).
An int 3-tuple of a (major, minor, patch) version.
-<a id="#versions.check"></a>
+<a id="versions.check"></a>
## versions.check
@@ -59,7 +62,7 @@ Check that the version of Bazel is valid within the specified range.
| <a id="versions.check-bazel_version"></a>bazel_version | the version of Bazel to check. Used for testing, defaults to native.bazel_version | <code>None</code> |
-<a id="#versions.is_at_most"></a>
+<a id="versions.is_at_most"></a>
## versions.is_at_most
@@ -79,10 +82,10 @@ Check that a version is lower or equals to a threshold.
**RETURNS**
-True if version <= threshold.
+True if version &lt;= threshold.
-<a id="#versions.is_at_least"></a>
+<a id="versions.is_at_least"></a>
## versions.is_at_least
@@ -102,6 +105,6 @@ Check that a version is higher or equals to a threshold.
**RETURNS**
-True if version >= threshold.
+True if version &gt;= threshold.