Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Update examples for axisgrid1 #9447
jklymak left a comment •
Thanks again for these.
I'd drop "Example" from all of these. They are self-evidently examples.
I also think we should stop calling these "Demo X Y", etc. Its also evident they are demos. More clever titles but still short titles would be helpful.
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?
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.
Oct 19, 2017
2 of 5 checks passed
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> .