-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: some minor fixes to the usage rewrite #21794
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Why all the extra |
Ah, because if you don't SG put "Out: Legend(...)" in a yellow box after everything. I could just put semicolons I guess? |
I'm +1 for semicolons as opposed to |
Hmm, except semicolons are a flake8 exception... |
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.
Lets leave it with plt.show()
s then, not a big deal 😄
This commit drops the shows, adds |
I don't think we should add in the https://sphinx-gallery.github.io/stable/configuration.html#prevent-capture-of-certain-classes |
I understand in general we do not want semicolons at the end of statements, but in this case it serves a really useful purpose - it saves the extra useless and confusing output, or it saves a spurious |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
I'm in favor of not backporting this and letting the examples start to diverge again. |
I think we should back-port these, as the current Usage Guide is very sparse.... |
DOC: some minor fixes to the usage rewrite
DOC: some minor fixes to the usage rewrite
…3.5.0-doc Manual Backport #21794 from jklymak/doc-basic-usage-fixes
I have no idea why, but the yellow output boxes are still present in the current devdocs Basic Usage tutorial, despite the semicolons. |
Yes, that didn't work too well ;-) |
PR Summary
This fixes a few typos and missed commas in
usage.py
.Follow up of #21641
PR Checklist
Tests and Styling
pytest
passes).flake8-docstrings
and runflake8 --docstring-convention=all
).Documentation
doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).