From 9d7ca273d1e723851ac913a2a62b85529c2cb638 Mon Sep 17 00:00:00 2001 From: Eric Cousineau Date: Fri, 5 Mar 2021 12:08:13 -0500 Subject: [PATCH] try to encode more deets --- .../development/architecture/upgrade-options.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/html/development/architecture/upgrade-options.rst b/docs/html/development/architecture/upgrade-options.rst index 2f1ced013c2..76c7d1fc00c 100644 --- a/docs/html/development/architecture/upgrade-options.rst +++ b/docs/html/development/architecture/upgrade-options.rst @@ -44,10 +44,15 @@ what *other* packages can be upgraded: pip command or a requirement file (i.e, they are direct requirements), or an upgraded parent needs a later version of the dependency than is currently installed. -* ``to-satisfy-only`` (**undocumented**) - packages are not upgraded (not - even direct requirements) unless the currently installed version fails to - satisfy a requirement (either explicitly specified or a dependency). This - is actually the "default" strategy when ``--upgrade`` is not set. +* ``to-satisfy-only`` (**undocumented, please avoid**) - packages are not + upgraded (not even direct requirements) unless the currently installed + version fails to satisfy a requirement (either explicitly specified or a + dependency). + + * This is actually the "default" upgrade strategy when ``--upgrade`` is + *not set*, i.e. ``pip install AlreadyInstalled`` and + ``pip install --upgrade --upgrade-strategy=to-satisfy-only AlreadyInstalled`` + yield the same behavior. ``--force-reinstall``