Update examples for axisgrid1 #9447
Conversation
| @@ -3,6 +3,7 @@ | |||
| Demo Axes Divider | |||
| ================= | |||
|
|
|||
| Example using Axes divider to calculate location of axes and create a divider for them using exisiting axes instances. | |||
There was a problem hiding this comment.
This line isn't pep8: it's too long.
You can probably configure your text editor to show you the lines that don't follow pep8 automatically.
| @@ -3,6 +3,8 @@ | |||
| Demo Axes Divider | |||
| ================= | |||
|
|
|||
| Example using Axes divider to calculate location of axes | |||
There was a problem hiding this comment.
I think this needs to be one line for sphinx-gallery to parse it properly. I could be wrong though... @NelleV do you know?
|
My concerns still stand. “Example demonstrating....” is (doubly!) redundant. “Demo Axes Divider” should just be “Axes Divider” etc. |
|
This looks good to me - agree that it'd be better if "demo" or "example" weren't in there, but IMO we can handle those things in a subsequent blanket PR that makes this fix for all examples...I get the feeling that there are many places where this problem of redundancy is in the docs. Shall I open an issue about it? |
|
@choldgraf true, there are many examples having that redundancy, it should be uniform and no example should have them in that case. I can remove it in this PR only or a separate PR later for all of them whatever seems right? |
|
@divyam3897 You can remove the redundancy from the caption text, and we can worry about the redundancy in the titles later is what I think @choldgraf means. Thanks! |
|
We have a lot of examples, so I wouldn't attempt to do this all at once. What is important is to have meaningful titles and description of the content of the example. "Example demonstrating Hbox Divider to arrange subplots." doesn't really describe what Hbox divider does or how it helps arrange subplots for example. I'm fine merging this as is, as it is an improvement on the current state of the gallery (thanks for the patch!), but in general, I'd rather have less examples or changes, but more meaningful one. |
|
@jklymak @NelleV @choldgraf I made the changes, let me know if I can improve them more 👍 |
|
Thanks a lot @divyam3897 So just for reference, I think these descriptions at the top of examples can be as long as we like? If so, I don't think it hurts future ones to be a bit more informative if warranted (without them becoming a full-on tutorial) |
|
@jklymak so a 2-3 lines of description would be better? |
|
@divyam3897 Not sure - I'm relatively new too, but I don't think it would hurt. If you are going through a few more of these, and the example is complicated, feel free to use a couple of lines. We can always edit it back. |
|
Yep, I was mistaken in thinking the first sentence could only be one line.
That said, the first sentence should be short and to the point. Longer
descriptions should come in the paragraphs after the first sentence.
…On Thu, Oct 19, 2017, 12:33 PM Jody Klymak ***@***.***> wrote:
Thanks a lot @divyam3897 <https://github.com/divyam3897>
So just for reference, I think these descriptions at the top of examples
can be as long as we like? If so, I don't think it hurts future ones to be
a bit more informative if warranted (without them becoming a full-on
tutorial)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#9447 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABwSHeqCHK_TbY7V5WET4xkT2WGt8CCtks5st6QcgaJpZM4P7L72>
.
|
|
@tacaswell not backporting automatically? |
|
@meeseeksdev backport to v2.1.0-doc |
Backport PR #9447 on branch v2.1.0-doc
Add description for examples for axisgrid1/demo_axis_*
Extension to #8921