Tags for simple_scatter.py demo #27302
Conversation
|
|
||
| # %% | ||
| # | ||
| # .. tags:: component: animation, component: scatter, purpose: reference, level: intermediate |
There was a problem hiding this comment.
I think scatter is plot_type: scatter?
There was a problem hiding this comment.
Corrected. thank you!
There was a problem hiding this comment.
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.
| # .. tags:: component: animation, plot type: scatter, | ||
| # .. tags:: purpose: reference, level: intermediate |
There was a problem hiding this comment.
| # .. tags:: component: animation, plot type: scatter, | |
| # .. tags:: purpose: reference, level: intermediate | |
| # .. tags:: component: animation, plot type: scatter, purpose: reference, level: intermediate |
tags can all be on one line.
There was a problem hiding this comment.
I think this edit should be made for two reasons:
-
the rendering makes it so that there are two
Tags:sections in the html -
the trailing comma makes it treat
""as a tag which displays oddly and I think is causing the doc build failure.
That said, putting it on one line does break linting due to line length, does the tag directive have a good way of dealing with that/splitting across lines in the same directive?
There was a problem hiding this comment.
So I think question for @melissawm if the following would be an ok ask
.. tags::
tag1, ......., tagn
tagn+1, ....., tagn+8
There was a problem hiding this comment.
Thank you for reviewing the commits and the suggestion! I made the change suggested above
There was a problem hiding this comment.
I think that is a reasonable suggestion. I will open an issue on sphinx-tags and try to get to it. For now can we ignore the linting on this line/file?
|
Cycling to rerun doc test |
|
@ksunden so I've got multiline content tags implemented, it's just waiting on reviews and merging melissawm/sphinx-tags#84 which should be good to go after melissawm/sphinx-tags#89 But doc tests will fail w/o those PRs in. |
|
@gougouasmi did you want to handle the rest of your tags? I left them out of my batch PRs in case you did. |
|
Hello @story645 ! I am a bit lost about what to do from here. Are we waiting on two other PRs? melissawm/sphinx-tags#84 and melissawm/sphinx-tags#89 |
Kinda - those implement support for putting the tags in the body of the directive: .. tag::
t1, t2, etc
But tags on one line work perfectly well. Basically if you're still interested you can put in the PR even if it'll be a bit before it can get merged - just put the tags on one line to test that it works. |
|
Those upstream PRs are merged and released now; does this just need a rebase? |
50e8701 to
d6fee60
Compare
d6fee60 to
211239c
Compare
|
i took the liberty of rebasing b/c I feel bad that we've dragged this out so long. Sorry @gougouasmi! |
211239c to
66dfeaa
Compare
|
removed comma and put each on its own line |
|
Thanks @gougouasmi! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again. |
PR summary
Hello! This PR adds the tags for the simple scatter demo. I tagged a few more examples during the sprint. I wanted to start with just one to see how it goes.
Link to the scatter demo:
https://matplotlib.org/devdocs/gallery/animation/simple_scatter.html
Related: #27235
PR checklist