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.

Sign up for GitHub

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

Jump to bottom

Minor clean up for documentation #250

Open
PipKat opened this issue Jul 25, 2023 · 0 comments
Open

Minor clean up for documentation #250

PipKat opened this issue Jul 25, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@PipKat
Copy link
Member

PipKat commented Jul 25, 2023 •
edited
Loading

Description of the modifications

Minor improvements for doc:

  • In the calc_functions.rst file, the equation for NodeToElem() could be better formatted to look like those for other calculator functions.
  • Consider converting the image /_static/UM-C7-12.png to SVG file for possibly making the display better in dark mode.
  • Fix display issues in the rendered doc. The Object API reference, which is imported, has truncated descriptions on its landing page. Also, on the landing page for the Session class, there are some method descriptions that are truncated.

Useful links and references

No response
@PipKat PipKat added the documentation Improvements or additions to documentation label Jul 25, 2023
This was referenced Jul 25, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PipKat