joerick / joerick/pyinstrument
Examples with explanations in doc
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 301
- PR merge metrics
- No merged PRs in 30d
Description
It would be really helpful for newcomers to have example outputs and explanations in docs.
For example, I spent few hours looking what [self] means in HTML output. I'm sure there will be other cases when there is something different than [self] and it's hard for newcomers to explain why their code spends most of the time there.
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 locating the documentation that explains HTML output and the meaning of [self]. Review the profiler output examples and identify other values that newcomers may find difficult to interpret. Done means the relevant documentation includes representative outputs with explanations; the issue does not name a specific documentation file or test.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100