Skip to content

Commit

Permalink
Fix installation instructions in the Contributing guide (#2089)
Browse files Browse the repository at this point in the history
### What kind of change does this PR introduce?

* Fix installation instructions in the Contributing guide

### Does this PR introduce a breaking change?

No.
  • Loading branch information
Zeitsperre authored Feb 27, 2025
2 parents 223d8d1 + 1eaa953 commit 4732fdb
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ Changelog

v0.56.0 (unreleased)
--------------------
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`).
Contributors to this version: Trevor James Smith (:user:`Zeitsperre`), Hui-Min Wang (:user:`Hem-W`).

Bug fixes
^^^^^^^^^
* Fix installation instructions in the Contributing guide (:issue:`2088`, :pull:`2089`).

Breaking changes
^^^^^^^^^^^^^^^^
Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,9 @@ Ready to contribute? Here's how to set up `xclim` for local development.

.. code-block:: shell
conda create -n xclim python=3.10 --file=environment.yml
python -m pip install -e --no-deps .
conda env create --file environment.yml
conda activate xclim
python -m pip install -e . --no-deps
#. Create a branch for local development:

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,6 @@ To create a conda environment including `xclim`'s dependencies and several optio

.. code-block:: console
conda env create -n my_xclim_env python=3.10 --file=environment.yml
conda env create -n my_xclim_env --file=environment.yml
conda activate my_xclim_env
(my_xclim_env) python -m pip install --no-deps -e .

0 comments on commit 4732fdb

Please sign in to comment.