Monitor service documentation lacks all detail
Open
- Dominant language
- Python
- Stars
- 497
- Forks
- 77
- Avg merge
- 22h 37m
- Merged PRs (30d)
- 45
Description
https://fluent.docs.pyansys.com/version/stable/api/services/monitor.html#ansys.fluent.core.services.monitor.MonitorsService
Currently, this only refers to a method `get_monitors_info()`, stating that it returns a `dict`.
Contributor guide
Research direction
Open the linked Monitor service API page and inspect the documentation for MonitorsService.get_monitors_info(). Identify what the method returns and document the available detail beyond the current statement that it returns a dict. Done means the API entry explains the method sufficiently for a user to understand its result.
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
- 55/100