Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.1k
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 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
dstansby commentedNov 29, 2021
Why all the extra |
jklymak commentedNov 29, 2021
Ah, because if you don't SG put "Out: Legend(...)" in a yellow box after everything. Icould just put semicolons I guess? |
dstansby commentedNov 29, 2021
I'm +1 for semicolons as opposed to |
jklymak commentedNov 29, 2021
Hmm, except semicolons are a flake8 exception... |
dstansby left a comment
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 withplt.show()s then, not a big deal 😄
jklymak commentedNov 29, 2021
This commit drops the shows, adds |
greglucas commentedNov 29, 2021
I don't think we should add in the https://sphinx-gallery.github.io/stable/configuration.html#prevent-capture-of-certain-classes |
jklymak commentedNov 29, 2021
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 tosuggest 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 tosuggest an improvement. |
tacaswell commentedNov 29, 2021
I'm in favor of not backporting this and letting the examples start to diverge again. |
QuLogic commentedNov 30, 2021
jklymak commentedNov 30, 2021
I think weshould 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-docManual Backport#21794 from jklymak/doc-basic-usage-fixes
StefRe commentedDec 5, 2021
I have no idea why, but the yellow output boxes are still present in the currentdevdocs Basic Usage tutorial, despite the semicolons. |
jklymak commentedDec 5, 2021
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
pytestpasses).flake8-docstringsand 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).