Example metadata for gallery examples #11490
Conversation
|
cc @tcmetzger Would love your input. @hyles-lineata and I worked to come up with this basic organizational system, this PR is intended as a final draft before rolling out similar additions to all the gallery examples. Note the "keywords" portion is still a bit vague. Eventually I'd like to tie in sphinx's cross-referencing capabilities somehow, but for now it's just some hand-curated terms |
|
This looks great and will be very good to have in the gallery! Just some thoughts on the displayed text: I'd suggest capitalizing each new line, i.e. "Sampledata:", "Bokeh API:", etc. We should at least make sure to consistently capitalize "Bokeh" (i.e. the second element in the list). I would also suggest to change "references:" to something like "User guide references:" or just "User guide:" - otherwise this might be confused with a link to the reference guide. Eventually, it would also be nice to make all keywords clickable, so that clicking on "scatter" would get me to a list of all examples with the "scatter" keyword, for example. |
I'd like to keep it more general, e.g. links could be to user guide, or reference guide, tutorial notebooks, etc. I'd also like to keep the LHS short/concise. Maybe just "Links" ? "Related" ? "More info" ?
Edit n/m I thought you were talking about all the API calls in the code. Yes that kind of cross referencing is exactly what I'd like. |
|
@bryevdv That sounds good - my preference would be "More info" but I think they would all work! |
|
Headings capitalized, pipes removed! |
This is suspicious, |
|
You're right; I screwed up there. Trying to do too many things at once. Will roll back. |
|
This pull request introduces 9 alerts when merging 2590030 into 23bf76b - view on LGTM.com new alerts:
|
|
LGTM I think I cleared the minor codebase issues editing in the GH web UI. If so I'll merge when green so that the new directive is available for others to use! |
* first round of docstrings added * removed some file outputs * pipes removed; subject headings capitalized * added bokeh-example-metadata directive * removing unused imports * trailing lines * isort Co-authored-by: carolyn <carolyn@bokeh.org> Co-authored-by: Bryan Van de Ven <bryan@bokeh.org>
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Adding ReST docstrings to examples in gallery.