ansys / ansys/pyfluent

Meaningful help text on every public API item

Open
#4,736 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
497
Forks
77
Avg merge
22h 37m
Merged PRs (30d)
45

Description

Meaningful help text on every public API item in PyFluent source code

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the PyFluent source code and inventorying its public API items to find which lack meaningful help text. Use existing help text as a reference, and consider the work complete when every public API item has meaningful help text.

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
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.