Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: better separation of codespace instructions#29526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
I also did not touch the "Install external dependencies" section, but I seem to have confused git(hub) diff. Locally, Tkdiff coped much better. |
doc/devel/development_setup.rst Outdated
| Decide whether to work locally or in GitHub Codespaces | ||
| ====================================================== | ||
| If you are making a one-off, relatively simple change then working in GitHub |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe add one sentence to set the stage. We shouldn’t assume everybody knows what Codespaces is. Something like
You can either work locally on your machine, or online inGitHub Codespaces, a cloud-based in-browser development environment.
3b329d9 intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
As a question for a potential follow up, was nested tabs too clunky or was it about keeping the link structure? I get the need for the change, I'm just not a fan of jump instructions in narrative so cycling through options. |
I actually tried nested tabs first, with the three local sections I’ve skipped as one tab and codespaces as the other. The headings for those three sections just didn’t show up in the tab. I’m pretty inexperienced with Sphinx so maybe I was missing something. |
PR summary
Currently the codespace instructions are a third tab next to setting up your python environment with either
venvorconda. This feels a bit out of place to me because the instructions are about more than just getting your python environment: they also include how to get an interactive gui or view the docs under codespaces. Additionally, when you spin up a codespaces instance, your clone is already there, upstream is already set and all the non-python dependencies are in place. So we can skip sections that are currently before and after the "create a dedicated environment" section. The instructions themselves are unchanged, just moved from the tab to a new section. I also added some brief guidance on why you might or might not want to choose codespaces.Closes#29524
PR checklist