From fe2ff0aa74dd5a942b33b3a4fdb108dc9675e7b5 Mon Sep 17 00:00:00 2001 From: lilydjwg Date: Mon, 9 Dec 2019 12:50:55 +0800 Subject: [PATCH] make it clearer that github releases are not those tags closes #123. --- README.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index aa908f6..f02ffd9 100644 --- a/README.rst +++ b/README.rst @@ -287,10 +287,15 @@ path Only commits containing this file path will be returned. use_latest_release - Set this to ``true`` to check for the latest release on GitHub. An annotated - tag creates a "release" on GitHub. It's not the same with git tags, which - includes both annotated tags and lightweight ones. Will return the release name - instead of date. + Set this to ``true`` to check for the latest release on GitHub. + + GitHub releases are not the same with git tags. You'll see big version names + and descriptions in the release page for such releases, e.g. + `zfsonlinux/zfs's `_, and those + small ones like `nvchecker's `_ + are only git tags that should use ``use_max_tag`` below. + + Will return the release name instead of date. use_max_tag Set this to ``true`` to check for the max tag on GitHub. Unlike