Improve descriptions of node types
- Dominant language
- Python
- Stars
- 39
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
The descriptions of each node type in [node_type_handlers.py](https://github.com/Ivareh/pg-explain-optimize-dashboard/blob/main/db-optimize-logger/app/node_type_handlers.py) are minimal; they could be more accurate and detailed.
[Pev2](https://github.com/dalibo/pev2) provides better descriptions—if we credit them, perhaps we could ask permission to use some of theirs.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in db-optimize-logger/app/node_type_handlers.py and compare the existing node-type descriptions with the corresponding descriptions in Pev2. Improve the descriptions for accuracy and detail, while checking how Pev2 should be credited and whether permission is needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql, python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100