Docs: Remove env_developer.yml from install guide by tovogt · Pull Request #727 · CLIMADA-project/climada_python

@tovogt

peanutfun

@tovogt

Ah, okay, I missed that part. I thought I was in the section about developer instructions already. And the dev requirements used to be the default here before. But I'm fine with removing the extra part.

@tovogt tovogt changed the title DOC: Mention [dev] extra in install guide Docs: Remove env_developer.yml from install guide

May 23, 2023

@tovogt

@tovogt

I added your suggested changes.

Are you aware that the Install Developer Dependencies (Optional) section claims that [test] is required to run the tests, but you already run tests as an example at the end of the previous Advanced Instructions where this extra is not installed yet?

@peanutfun

@tovogt I admit, this is a bit imprecise. Executing python -m unittest climada.engine.test.test_impact does not require the test extras. These extras mostly contain "test tools" like coverage etc.

@peanutfun

I tried to mention this somewhat explicitly:

Building the documentation and running the entire test suite of CLIMADA requires additional dependencies

(emphasis by me)

@tovogt Do you think this is clear enough or should we change something about that?

@tovogt

Don't worry, I think it's clear enough. Thanks for considering my concerns :)

@peanutfun

Great, thanks a lot for taking your time and fixing the docs! 🎉

peanutfun