Skip to content

Commit 9e52e98

Browse files
authored
Update docs to add info on stable versions (#49)
1 parent 45db332 commit 9e52e98

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ Package installation
4040
4141
pip install rimseval
4242
43-
Add ``--pre`` flag for pre-releases or install the latest version from GitHub.
43+
If pre-releases are available and you would like to install one,
44+
add the ``--pre`` flag to above command.
4445
More information in the
4546
`documentation <https://rimseval.readthedocs.io/en/latest/>`_.
4647

docs/gui/install.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,12 @@ you can simply type:
164164
git pull
165165
git install -r requirements.txt --upgrade
166166
167+
.. note:: Newer versions of the GUI can depend on development versions
168+
of ``rimseval``. This means that you might see unexpected and wrong behavior.
169+
The packaging tool of the GUI does not allow for specifically labeling of such versions.
170+
Therefore, it is up to he user to ensure that you have the version that you like.
171+
New versions that depend on development versions of ``rimseval`` will always be labeled
172+
on GitHub as pre-releases. They will therefore not show up in the update reminder of the software.
167173

168174
------
169175
Python

0 commit comments

Comments
 (0)