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

More complete linking of API methods in Gallery Examples #5111

Open
MatthewFlamm opened this issue Oct 20, 2023 · 0 comments
Open

More complete linking of API methods in Gallery Examples #5111

MatthewFlamm opened this issue Oct 20, 2023 · 0 comments
Labels
good first issue 🍏 low-hanging-fruit A great issue for first time contributors to get their hands dirty maintenance Low-impact maintenance activity

Comments

@MatthewFlamm
Copy link
Contributor

Describe what maintenance you would like added.

The gallery examples are extremely useful to help users get started. But, often I want to jump from the example to the detailed documentation for the particular method that is used in the example. An example of a gallery example that does this well is https://docs.pyvista.org/version/stable/examples/01-filter/clipping.html, where links to clip, clip_box and so on are provided. An example of a gallery example that does not currently do this well is https://docs.pyvista.org/version/stable/examples/01-filter/project-plane.html where there is no link to project_points_to_plane.

Links to source code.

Example that links to detailed documentation:
https://github.com/pyvista/pyvista/blob/v0.42.3/examples/01-filter/clipping.py

Example that doesn't link to detailed documentation:
https://github.com/pyvista/pyvista/blob/v0.42.3/examples/01-filter/project-plane.py

Pseudocode or Screenshots

No response

@MatthewFlamm MatthewFlamm added maintenance Low-impact maintenance activity 🍏 low-hanging-fruit A great issue for first time contributors to get their hands dirty good first issue labels Oct 20, 2023
@tkoyama010 tkoyama010 pinned this issue Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue 🍏 low-hanging-fruit A great issue for first time contributors to get their hands dirty maintenance Low-impact maintenance activity
Projects
None yet
Development

No branches or pull requests

1 participant