ansys / ansys/pydpf-post

Improve docstrings for result APIs

Open
#356 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
57
Forks
13
Avg merge
3d 3m
Merged PRs (30d)
4

Description

### 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_

Contributor guide

Open the contributing guide

Research direction

Start with the existing examples in ModalMechanicalSimulation.displacement() and inspect the docstrings for the result APIs. Add a specific stress example showing location, then use it as the reference for examples in the other result types. Done means the result API docstrings consistently include these examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.