ansys / ansys/pyprimemesh

Fix docstrings from `download_utilities` and `mesh_util`

Open
#525 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
35
Forks
14
Avg merge
3d 5h
Merged PRs (30d)
11

Description

A couple of docstrings are not clear enough, the following comments in PR #509 have to be fixed:
- https://github.com/ansys/pyprimemesh/pull/509#discussion_r1239960002
- https://github.com/ansys/pyprimemesh/pull/509#discussion_r1239961700

Contributor guide

Open the contributing guide

Research direction

Read the two review discussions linked from PR #509, then locate the affected docstrings in download_utilities and mesh_util. Update those docstrings to address the comments, and confirm that both review points are resolved.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.