Skip to content

[Doc]: Remove "keywords" line at the bottom of all examples #22391

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
anntzer opened this issue Feb 4, 2022 · 7 comments · Fixed by #22405
Closed

[Doc]: Remove "keywords" line at the bottom of all examples #22391

anntzer opened this issue Feb 4, 2022 · 7 comments · Fixed by #22405
Labels
Documentation: website layout/behavior/styling changes
Milestone

Comments

@anntzer
Copy link
Contributor

anntzer commented Feb 4, 2022

Documentation Link

https://matplotlib.org/devdocs/gallery/lines_bars_and_markers/bar_label_demo.html

Problem

All of the examples contain the following line at the bottom of the page: "Keywords: matplotlib code example, codex, python plot, pyplot". This should be removed, although removal of codex should be coordinated with the search page, which currently states

If you want to limit your search to working code examples, include the keyword "codex" (mnemonic for code example) in your search, e.g., "codex ellipse".

Suggested improvement

No response

Matplotlib Version

3.6.0.dev1530

@anntzer anntzer added the Documentation: website layout/behavior/styling changes label Feb 4, 2022
@soma2000-lang
Copy link

I am working on this issue.

@tacaswell
Copy link
Member

Why do we want to remove them rather than making them more accurate?

Can we at least preserve 'codex' for the search functionality?

@tacaswell tacaswell added this to the v3.6.0 milestone Feb 4, 2022
@anntzer
Copy link
Contributor Author

anntzer commented Feb 4, 2022

We can certainly make them more accurate instead of removing them; my point is more that right now they are totally uninformative (except for "codex").

@timhoffm
Copy link
Member

timhoffm commented Feb 4, 2022

I find "codex" very jargony. Also, you have to read the heading of the search result site to know about it. I bet most of the users only use the search field in the side bar and then look through the results.

What I would find more usable is

  1. have different symbols for different result categories (example, tutorial, api ...)
  2. A filter on the result categories

But that's going into sphinx, and I don't have time for that.

If you want to keep keywords for serach (?) reasons, can we make them invisible to the user? IMHO the don't have a benefit for the reader of the example and thus are only clutter.

@QuLogic
Copy link
Member

QuLogic commented Feb 4, 2022

I have an idea of how to implement that, but it's tied to our hosting issues. We can maybe discuss on the call when I have the budget drawn up.

@jklymak
Copy link
Member

jklymak commented Feb 5, 2022

If you want to keep keywords for serach (?) reasons, can we make them invisible to the user? IMHO the don't have a benefit for the reader of the example and thus are only clutter.

sphinx allows a meta directive that can contain keywords, which will go in the html meta rather than printed on the page. Given that we are injecting these somehow, I'm sure we could instead inject them to the meta directive.

@timhoffm
Copy link
Member

timhoffm commented Feb 5, 2022

The cheapest way is probably to make the text white. Maybe that's a good hack until we come up with something better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: website layout/behavior/styling changes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants