Skip to content
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

[MNT]: Remove the userdemo section in examples #25800

Open
timhoffm opened this issue May 1, 2023 · 4 comments · May be fixed by #25881
Open

[MNT]: Remove the userdemo section in examples #25800

timhoffm opened this issue May 1, 2023 · 4 comments · May be fixed by #25881

Comments

@timhoffm
Copy link
Member

timhoffm commented May 1, 2023

Summary

https://matplotlib.org/devdocs/gallery/index.html#userdemo

This section was a collection of plots used via .. literalinclude:: in the user documentation.

It's existence was only motivated structurally. This does not fit with the semantic sectioning of the examples. Userdemo should thus be removed.

Proposed fix

If the examples are still used in an .. literalinclude::, they should be converted to a figure directive.

If they are not used anymore, they should either

@QuLogic
Copy link
Member

QuLogic commented May 2, 2023

If the examples are still used in an .. literallyinclude::, they should be converted to a figure directive.

I don't believe there are any cases of this markup.

@timhoffm
Copy link
Member Author

timhoffm commented May 2, 2023

Sorry, typo in the directive. It is .. literalinclude::

image

@enriched-h
Copy link

Hi @timhoffm I am new to open source and I would like to be assigned this issue. Can you please provide guidance on how I can resolve this issue.

@rcomer
Copy link
Member

rcomer commented May 4, 2023

Hi @enriched-h you are welcome to submit a pull request for any issue, but we do not assign them. Feel free to ask any specific questions about this issue here or, if you prefer, in our incubator gitter room.

Please also see our contributors’ guide:
https://matplotlib.org/devdocs/devel/contributing.html

Sigma-Verma added a commit to Sigma-Verma/matplotlib that referenced this issue May 11, 2023


To address this issue, the proposed fix is to convert the examples in the userdemo section from literalinclude to figure directives if they are still used in the documentation. This will allow the examples to be displayed as figures rather than code snippets
@jklymak jklymak linked a pull request May 13, 2023 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants