DOC: make nightly download command one line so it works on Windows#31231
Conversation
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. You can also join us on gitter for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
|
Thanks for the PR! I think you should use tabs instead of the note: https://sphinx-design.readthedocs.io/en/latest/tabs.html |
|
Windows should be able to use caret |
|
I would just always give the command as a single line to sidestep the issue and avoid transforming the docs into a cmd tutorial. |
|
It's a bit of a trade-off. The command is so long that you won't be able to read it reasonably when viewing the docs. An improvement could be auto-wrapping. Should be possible by adding a |
Thanks for the suggestion! I’ve updated the documentation to use a single-line pip command to avoid the Windows CMD line continuation issue. |
|
Thanks for the suggestions! I updated the PR to use a single-line command based on the earlier recommendation. I'm happy to adjust it further if using the Windows caret ( |
| On Windows Command Prompt, line continuation using ``\`` is not supported. | ||
| Run the above command as a single line instead, e.g.: | ||
|
|
||
| ``python -m pip install --upgrade --pre --index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple --extra-index-url https://pypi.org/simple matplotlib`` |
There was a problem hiding this comment.
I'm pretty sure the suggestion for using one line was so that you could use the same command for Linux and windows.
There was a problem hiding this comment.
But now we no longre need L103-109?
There was a problem hiding this comment.
the whole thing gets replaced w/:
python -m pip install --upgrade --pre --index-url https://pypi.anaconda.org/scientific-python-nightly-wheels/simple --extra-index-url https://pypi.org/simple matplotlib|
Five core developers have looked at this and waiting that the author removes some lines. Since this wasn't moving, I took the liberty to remove the unnecessary part. IMHO this is not a devaluation of the work of the PR author, but a necessary means of efficiency: @amishamehta99 Thanks for the work, it's almost there, we've covered the last remaining minor issue so that we can merge and move on. The (optional) CSS styling can be done in a follow-up PR. |
|
The one-line version now looks like this: I think that's ok and introducing wrapping would make the code more confusing: So I suggest not to do any follow up. |
|
I think before we started using sphinx-copybutton (#12997) it would have been awkward to copy/paste the long line, but now it doesn't really matter. |
This PR adds a clarification note for Windows Command Prompt users
in the "Install a nightly build" section.
Windows CMD does not support line continuation using "".
Without this clarification, the multi-line pip command may fail
for Windows users.
This change improves clarity and avoids installation errors.