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

Graphics class API doc is missing doc on key members #303

Open
ansAFinney opened this issue Jul 13, 2023 · 1 comment
Open

Graphics class API doc is missing doc on key members #303

ansAFinney opened this issue Jul 13, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@ansAFinney
Copy link

Description of the modifications

I see

image

the example is showing members of the Graphics class e.g. Meshes but those members are not directly documented here
There should be Meshes link somewhere here. I know Mesh is visible on the left but that doesn't document the Meshes member.

Useful links and references

see https://visualization.fluent.docs.pyansys.com/version/stable/api/visualization/graphics.html

@ansAFinney ansAFinney added the documentation Improvements or additions to documentation label Jul 13, 2023
@seanpearsonuk
Copy link
Collaborator

also, when I click on Mesh in the tree under Graphics, I see this:

class ansys.fluent.visualization.pyvista.pyvista_objects.Mesh(name, parent, api_helper)
Provides for displaying mesh graphics.

Parameters:
name
parent
api_helper
.. code-block:: python
from ansys.fluent.visualization.pyvista import Graphics

graphics_session = Graphics(session) mesh1 = graphics_session.Meshes[“mesh-1”] mesh1.show_edges = True mesh1.surfaces_list = [‘wall’] mesh1.display(“window-0”)

n.b. code-block

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
Projects
None yet
Development

No branches or pull requests

2 participants