Make sure usage types and docstrings are statically shown in IDEs for generated API
Open
- Dominant language
- Python
- Stars
- 497
- Forks
- 77
- Avg merge
- 22h 37m
- Merged PRs (30d)
- 45
Description
E.g. some APIs are generated as class, but they will be used as methods by users. Make sure intellisense hints the usage type and the doctrings when user develops a PyFluent script statically in an IDE.
For testing ideas, see #4351 and #4351.
Contributor guide
Research direction
Start by reviewing the testing ideas in issue #4351 and tracing how the generated API is exposed to Python users. Done means IDE static analysis shows the correct usage type and docstrings for generated PyFluent APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100