ansys / pyacp

Python Client for Ansys Composite PrepPost
https://acp.docs.pyansys.com
MIT License
5 stars 1 forks source link

Doc: convert StrEnum defaults to their string value #651

Closed greschd closed 2 weeks ago

greschd commented 3 weeks ago

When building the documentation, convert any parameter defaults which are of type StrEnum to their string value, so that the string is shown in the signature rather than the enum name.

Closes #648

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.42%. Comparing base (7c99a57) to head (6a56239). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #651 +/- ## ========================================== - Coverage 94.49% 94.42% -0.08% ========================================== Files 99 99 Lines 5417 5417 ========================================== - Hits 5119 5115 -4 - Misses 298 302 +4 ``` | [Flag](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | Coverage Δ | | |---|---|---| | [python-3.10](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `?` | | | [python-3.11](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.31% <ø> (ø)` | | | [python-3.12](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.42% <ø> (ø)` | | | [server-2024R2](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `91.08% <ø> (ø)` | | | [server-2025R1](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.31% <ø> (ø)` | | | [server-latest](https://app.codecov.io/gh/ansys/pyacp/pull/651/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys) | `94.31% <ø> (-0.08%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansys#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.