ansys / ansys/pysystem-coupling
Hidden features are documented in PySystemCoupling API documentation
- Dominant language
- Python
- Stars
- 12
- Forks
- 6
- Avg merge
- 1d 18m
- Merged PRs (30d)
- 6
Description
### 🔍 Before submitting the issue
- [X] I have searched among the existing issues
- [X] I am using a Python virtual environment
### 🐞 Description of the bug
All hidden features are documented in PySystemCoupling API Reference. For example, here:
https://systemcoupling.docs.pyansys.com/version/0.4/api/core/settings/_autosummary/api/analysis_control.html#analysis-control
Options like `unmapped_value_options` are hidden behind an alpha flag and should be omitted from the documentation.
### 📝 Steps to reproduce
Open this page and see hidden features being documented:
https://systemcoupling.docs.pyansys.com/version/0.3/api/core/settings/_autosummary/api/unmapped_value_options.html
### 💻 Which operating system are you using?
Windows
### 📀 Which ANSYS version are you using?
24.1
### 🐍 Which Python version are you using?
3.10
### 📦 Installed packages
```shell
n/a
```
Contributor guide
Research direction
Start with the linked API Reference pages for analysis_control and unmapped_value_options, then trace those pages to the documentation source or configuration that exposes alpha-flagged members. Done means hidden features such as unmapped_value_options no longer appear in the generated PySystemCoupling API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100