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

Visualization Doc Needs a round of Updates #86

Open
dnwillia-work opened this issue Jul 19, 2022 · 1 comment
Open

Visualization Doc Needs a round of Updates #86

dnwillia-work opened this issue Jul 19, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@dnwillia-work
Copy link
Collaborator

dnwillia-work commented Jul 19, 2022

  • The API Reference page still says a single comment about describing the modules at a high level. This should be removed.
  • The getting started page should be made at least conceptually consistent with the Fluent one
  • The landing page could be tidied up: It still refers to PyFluent and it's features. This page should talk about the visualization package.
  • We should add more examples about how to create and plot all the different object types, eg: vector plots are missing. Also, it would be good to document the controls in more detail. For instance on the Mesh object page it's not really clear what show_edges, surfaces_list or surfaces_list.allowed_values are actually for. The descriptions simply restate the name of the member variable which is not useful.
  • For the Surface objects, what kind of surfaces? Is it for just boundary condition surfaces?, interior zones?, constructed surfaces like cut planes? etc.. This is not clear from the documentation. Same kind of applies to the other Graphics objects.
@dnwillia-work dnwillia-work added the documentation Improvements or additions to documentation label Jul 19, 2022
@dnwillia-work dnwillia-work changed the title Visualization Doc Needs an Upgrade Visualization Doc Needs a round of Updates Jul 19, 2022
@PipKat
Copy link
Member

PipKat commented Jul 27, 2022

Note that now that Vale (a linter for prose style checking) is implemented, the Vale and Documentation Style checks will fail if:

  1. Content doesn't follow the guidelines in the Google developer documentation style guide. In this case, you will have to edit the content to fix the style violation.
  2. New terms are encountered. In this case, you will have to add these terms to the accept.txt file. The location of this file (and more information about using the Vale) is now documented at the end of the Documentation style tools topic in the PyAnsys Developer's Guide.

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