Document the meaning of colours in the graph
Open
Nobody has claimed this yet.
enhancement
help-needed
- Dominant language
- Python
- Stars
- 840
- Forks
- 72
- PR merge metrics
- No merged PRs in 30d
Description
When calling objgraph.show_refs, some nodes can have their text coloured red. It's unclear what the meaning of this is. The documentation should specify this.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the documentation for objgraph.show_refs and inspecting its colour-handling behavior to determine what red node text signifies. Update the relevant documentation to explain that meaning, then verify that the show_refs documentation clearly covers the colour semantics.
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
- Clearly specified
- Newbie friendliness
- 35/100