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

Convert "practical guide" example to a tutorial #282

Open
wtbarnes opened this issue Sep 3, 2024 · 0 comments
Open

Convert "practical guide" example to a tutorial #282

wtbarnes opened this issue Sep 3, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation Examples Affects the example gallery

Comments

@wtbarnes
Copy link
Collaborator

wtbarnes commented Sep 3, 2024

The "practical guide to XRT data visualization" would be much more well suited as a tutorial rather than an example gallery entry. It is a long form walk through of how to do a sequence of tasks, with a clear beginning and end. In contrast, most example gallery entries are short how-to guides, ie they show how to quickly perform a single, specific task.

See the SunPy tutorial as an example of this type of content.

@wtbarnes wtbarnes added documentation Improvements or additions to documentation Examples Affects the example gallery labels Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Examples Affects the example gallery
Projects
None yet
Development

No branches or pull requests

1 participant