From 7002c3b058d6430d82cee396243a98dea9f33dbc Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 5 Jul 2022 00:28:22 +0000 Subject: [PATCH] f8c0dbd2e3bd15eda08c68ff844925323db3a359 --- _sources/index.rst.txt | 10 +++++----- _static/documentation_options.js | 2 +- genindex.html | 4 ++-- index.html | 14 +++++++------- search.html | 4 ++-- searchindex.js | 2 +- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt index a9382c0..45690a6 100644 --- a/_sources/index.rst.txt +++ b/_sources/index.rst.txt @@ -29,7 +29,7 @@ Parsing version(PARSE ) -Attempts to parse the version in ```` and stores the individual compoents into ``_``. If a component is not present in the given version, it will be undefined. If an error occurred, ``_ERROR`` will be defined and contain the error message. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be turned into a list if they are encountered. +Attempts to parse the version in ```` and stores the individual compoents into ``_``. If a component is not present in the given version, it will be set to a false constant. If an error occurred, ``_ERROR`` will contain the error message otherwise it will be a false constant. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be turned into a list if they are encountered. Generating ^^^^^^^^^^ @@ -40,7 +40,7 @@ Generating version(GENERATE [COMPRESS] [MAJOR ] [MINOR ] [PATCH ] [TWEAK ] [PRERELEASE ] [BUILD ]) -Generates a version from the components provided and stores the result in ````. The components ```` and ```` will default to ``0`` if not provided. If an error occurred, ``_ERROR`` will be defined and contain the error message. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be converted from a list if encountered. +Generates a version from the components provided and stores the result in ````. The components ```` and ```` will default to ``0`` if not provided. If an error occurred, ``_ERROR`` will contain the error message otherwise it will be a false constant. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be converted from a list if encountered. Modifying ^^^^^^^^^ @@ -51,7 +51,7 @@ Modifying version(MODIFY [COMPRESS] [MAJOR ] [MINOR ] [TWEAK ] [PRERELEASE ] [BUILD ]) -Modifies the version provided in ```` with the components provided. The components ````, ````, ```` and ```` may have a prefix of ``+`` or ``-`` to add and subtract the value, or no prefix to replace. The result of this operation will be stored as a string in ````. If a component did not exist in the original, it will be added to the version as a replace operation. If an error occurred, ``_ERROR`` will be defined and contain the error message. +Modifies the version provided in ```` with the components provided. The components ````, ````, ```` and ```` may have a prefix of ``+`` or ``-`` to add and subtract the value, or no prefix to replace. The result of this operation will be stored as a string in ````. If a component did not exist in the original, it will be added to the version as a replace operation. If an error occurred, ``_ERROR`` will contain the error message otherwise it will be a false constant. Comparing ^^^^^^^^^ @@ -69,7 +69,7 @@ Compares the version ```` against ```` and stores the result in ````, ```` will contain the componenent name prefixed by ``>``. - If a component is numerical and the value is larger in ````, ```` will contain the componenent name prefixed by ``<``. - If a component is alphanumerical and the value is different in either, ```` will contain the component name with no prefix. -- If an error occurred, ``_ERROR`` will be defined and contain the error message, and ```` will be undefined. -- In all other cases, ```` will be empty. +- If an error occurred, ``_ERROR`` will contain the error message otherwise it will be a false constant, and ```` will be a false constant. +- In all other cases, ```` will be a false constant. There is no special handling for dot-separated ``PRERELEASE`` and ``BUILD`` component. They will be treated as if they were a string, as special handling for these is up to the application. diff --git a/_static/documentation_options.js b/_static/documentation_options.js index 053d146..e414bab 100644 --- a/_static/documentation_options.js +++ b/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.1', + VERSION: '1.2', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/genindex.html b/genindex.html index 77a0ef8..e85ee2d 100644 --- a/genindex.html +++ b/genindex.html @@ -3,7 +3,7 @@ - Index — version 1.1 documentation + Index — version 1.2 documentation