Update documentation in simulation_setup modules
- Dominant language
- Python
- Stars
- 7
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Update the documentation of all the modules in [src/ansys/edb/core/simulation_setup](https://github.com/ansys/pyedb-core/tree/main/src/ansys/edb/core/simulation_setup)
- [ ] adaptive_solutions.py
- [ ] hfss_simulation_settings.py
- [ ] hfss_simulation_setup.py
- [ ] mesh_operation.py
- [ ] raptor_x_simulation_settings.py
- [ ] raptor_x_simulation_setup.py
- [ ] simulation_settings.py
- [ ] simulation_setup.py
- [ ] siwave_dcir_simulation_settings.py
- [ ] siwave_dcir_simulation_setup.py
- [ ] siwave_simulation_settings.py
- [ ] siwave_simulation_setup.py
- [ ] hfss_pi_simulation_settings.py
- [ ] hfss_pi_simulation_setup.py
- [ ] q3d_simulation_settings.py
- [ ] q3d_simulation_setup.py
Contributor guide
Research direction
Start by reviewing the modules in src/ansys/edb/core/simulation_setup, using the issue checklist to work through adaptive_solutions.py, the simulation settings and setup modules, and mesh_operation.py. Determine the documentation gaps in each listed file; the work is done when all 16 checked modules have updated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100