Shouldn't doc string say this is the unique id of a GRPC object?
Open
documentation
- Dominant language
- Python
- Stars
- 7
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/pyansys/pyedb/blob/c4af89b3e0c2412dd56fcb82c2635919405a337c/src/ansys/edb/core/base.py#L29
This is confusing since there is an EDB id as well. And does client need access to this id? Should it be private?
Contributor guide
Research direction
Start in src/ansys/edb/core/base.py at line 29 and inspect the docstring for the identifier described there. Clarify whether it is the unique GRPC object ID or the EDB ID, and verify whether clients need access to it; done means the terminology and visibility match the intended API.
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
- 35/100