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

Improve docstrings for result APIs #356

Open
PProfizi opened this issue Apr 4, 2023 · 0 comments
Open

Improve docstrings for result APIs #356

PProfizi opened this issue Apr 4, 2023 · 0 comments
Assignees
@PProfizi
Labels
documentation Improvements or additions to documentation
Milestone
v0.9.1

Comments

@PProfizi
Copy link
Contributor

PProfizi commented Apr 4, 2023

Description of the modifications

Add Examples in the docstrings of result APIs, like what was done in ModalMechanicalSimulation.displacement().

Do one specific for stress to illustrate location, then refer to those in the other result types.

Useful links and references

No response
@PProfizi PProfizi added the documentation Improvements or additions to documentation label Apr 4, 2023
@PProfizi PProfizi self-assigned this Apr 4, 2023
@PProfizi PProfizi added this to the v0.4.1 milestone Apr 4, 2023
@PProfizi PProfizi modified the milestones: v0.4.1, v0.5.1 Jul 27, 2023
@PProfizi PProfizi modified the milestones: v0.6.0, v0.6.1 Oct 16, 2023
@PProfizi PProfizi modified the milestones: v0.7.0, v0.7.1 Feb 21, 2024
@PProfizi PProfizi modified the milestones: v0.8.1, v0.8.2 Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PProfizi PProfizi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.9.1
Development

No branches or pull requests
1 participant
@PProfizi