Better document profile functionality
Open
@rok-cesnovar is already working on this.
Since Jan 10, 2022.
enhancement
help wanted
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Description
Summary:
The use and syntax of profile blocks is under-documented. A section in the users guide would be great, especially addressing:
- profiling overhead, if any
- Are profiling blocks like regular blocks (e.g. local variables drop at the end)
- How and when to use them
This will also be helpful for #396
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.
Assessment
This issue has not been assessed yet.