Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Added labels to images in the gallery [sprint]#2161
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
- Right now it's just the filename of the example- It should perhaps be a string that we define in the example file (like in scikits-image / scikits-learn)
| @@ -121,6 +121,7 @@ def generate_example_rst(app): | |||
| rstfile = '%s.rst'%basename | |||
| outrstfile = os.path.join(rstdir, rstfile) | |||
| # XXX make into title | |||
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.
I'm not sure I follow this comment. Would you mind expanding on this (in this github interface before adding a new commit)?
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.
It would be nice to write titles for each of the example plots, likely in a file-level docstring. I was just making a note to myself that if each plot has a title, then it'd be good to change the following line to something likefhsubdirIndex.write(' %s <%s>\n'%(filetitle,rstfile)).
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.
Ah, ok. Maybe you could update this comment along the lines of:
# XXX: We might consider putting extra metadata in the example files to include a title. If so, this line is where we would add this information.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.
Good idea.
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.
See#2174.
Great idea. I've wanted to be able to use ctrl+F for textual search for a while, so this really improves the situation. |
Apart from@pelson's comment, I'm 👍 |
👍 from me, too. |
Added labels to images in the gallery [sprint]
Right now the label is just the filename of the example, but it should be a string that we define in the example file (like in scikits-image / scikits-learn).