Skip to content

Commit 7702ae9

Browse files
Jammy2211claude
authored andcommitted
docs: drop --branch <version> from workspace clone instructions
Reverting to the simpler unpinned clone for now (and trimming the tag-pinning rationale paragraph alongside it). The tag-pinning approach needs a fresh look before it goes back in. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 5841536 commit 7702ae9

2 files changed

Lines changed: 6 additions & 10 deletions

File tree

docs/installation/conda.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,13 @@ the installation has clean dependencies):
2828
2929
pip install autofit
3030
31-
Next, clone the ``autofit_workspace`` at the tag matching your installed ``PyAutoFit`` version. Each
32-
``PyAutoFit`` release tags a paired ``autofit_workspace`` snapshot, so cloning by tag guarantees that the
33-
example scripts and notebooks were generated against the library version you installed:
31+
Next, clone the ``autofit_workspace`` (the line ``--depth 1`` clones only the most recent branch on
32+
the ``autofit_workspace``, reducing the download size):
3433

3534
.. code-block:: bash
3635
3736
cd /path/on/your/computer/you/want/to/put/the/autofit_workspace
38-
AUTOFIT_VERSION=$(python -c "import autofit; print(autofit.__version__)")
39-
git clone https://github.com/Jammy2211/autofit_workspace --branch $AUTOFIT_VERSION --depth 1
37+
git clone https://github.com/Jammy2211/autofit_workspace --depth 1
4038
cd autofit_workspace
4139
4240
Run the `welcome.py` script to get started!

docs/installation/pip.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,13 @@ the installation has clean dependencies):
2222
If this raises no errors **PyAutoFit** is installed! If there is an error check out
2323
the `troubleshooting section <https://pyautofit.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
2424

25-
Next, clone the ``autofit_workspace`` at the tag matching your installed ``PyAutoFit`` version. Each
26-
``PyAutoFit`` release tags a paired ``autofit_workspace`` snapshot, so cloning by tag guarantees that the
27-
example scripts and notebooks were generated against the library version you installed:
25+
Next, clone the ``autofit_workspace`` (the line ``--depth 1`` clones only the most recent branch on
26+
the ``autofit_workspace``, reducing the download size):
2827

2928
.. code-block:: bash
3029
3130
cd /path/on/your/computer/you/want/to/put/the/autofit_workspace
32-
AUTOFIT_VERSION=$(python -c "import autofit; print(autofit.__version__)")
33-
git clone https://github.com/Jammy2211/autofit_workspace --branch $AUTOFIT_VERSION --depth 1
31+
git clone https://github.com/Jammy2211/autofit_workspace --depth 1
3432
cd autofit_workspace
3533
3634
Run the ``welcome.py`` script to get started!

0 commit comments

Comments
 (0)