ansys / ansys/pyansys-tools-variableinterop
Cleanup: Docstring formatting
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Fix class/method docstrings to fit NumPy style guidelines. Examples here: https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html
```python
def f(x: int, y: str) -> bool:
"""
Method summary on one line.
Longer description after a blank line if necessary.
It can be multiple lines.
Parameters
----------
x : int
First parameter.
y : str
second parameter.
Returns
-------
bool
Result of the method.
"""
...
```
Contributor guide
Research direction
No files or tests are named in the issue. Start by locating the Python class and method docstrings in the repository, then compare them with the linked NumPy-style example; done means the applicable docstrings follow that format consistently.
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
- Needs clarification
- Newbie friendliness
- 25/100