DOC: Add clarifications to docs for setting up a development environment #56201
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi all - having just been through the setup process (Mac, mamba) and as a non-expert I thought I'd feed back some things that would have made my experience faster and smoother.
Change 1
https://devguide.python.org/setup/#macos
(it is clear with hindsight, but it's the initial impression that I'm trying to improve here):Before this change:
After:
Change 2
mamba
vsconda
, and that you actually need to install is calledminiforge
- I had a moment of doubt here that I was on the wrong track.Before this change:
Change 3
sphinx
that did not have a version pinned inenvironment.yml
. This feels like it could be a source of errors for people getting set up.After:
Change 4
Before this change:
After:
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.