Merge pull request #4188 from MetRonnie/fix-install-help

Fix cylc install help examples

CHANGES.md

@@ -71,6 +71,12 @@ during workflow run and post pause.
 [#4168](https://github.com/cylc/cylc-flow/pull/4168) - Fix bug where any
 errors during workflow shutdown were not logged.
 
+[#4161](https://github.com/cylc/cylc-flow/pull/4161) - Fix bug in in `cylc install`
+where a workflow would be installed with the wrong name.
+
+[#4188](https://github.com/cylc/cylc-flow/pull/4188) - Fix incorrect usage
+examples for `cylc install`.
+
 -------------------------------------------------------------------------------
 ## __cylc-8.0b0 (<span actions:bind='release-date'>Released 2021-03-29</span>)__
 

cylc/flow/scripts/install.py

@@ -56,12 +56,12 @@
   # run directory ~/cylc-run/fido/run1
   $ cylc install --flow-name=fido
 
-  # Install $PWD/bunny/rabbit/flow.cylc as "bunny/rabbit", with run directory
-  # ~/cylc-run/bunny/rabbit/run1
+  # Install $PWD/bunny/rabbit/flow.cylc as "rabbit", with run directory
+  # ~/cylc-run/rabbit/run1
   $ cylc install --directory=bunny/rabbit
 
-  # Install $PWD/cats/flow.cylc as "cats", overriding the run1, run2, run3 etc
-  # structure with run directory ~/cylc-run/cats/paws
+  # Install $PWD/flow.cylc as "cats", if $PWD is ~/cats, overriding the
+  # run1, run2, run3 etc. structure with run directory ~/cylc-run/cats/paws
   $ cylc install --run-name=paws
 
 The same workflow can be installed with multiple names; this results in