bloomberg / bloomberg/memray

Tutorials Update for exercise 1

Open
#839 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
15.2k
Forks
461
Avg merge
5d 3h
Merged PRs (30d)
10

Description

### Is there an existing proposal for this?

- [x] I have searched the existing proposals

### Is your feature request related to a problem?

When running tutorial exercise 1, the flamegraph that is currently generated is not a great visual way to explore the flamegraph. Specifically the tree has only 1 path, and its hard to show case that the x-axis of the flamegraphe represents size of memory allocated.

### Describe the solution you'd like

An updated tutorial example where we can see distinctly differently sized branches in the tree of the flamegraph.

### Alternatives you considered

_No response_

Contributor guide

Open the contributing guide

Research direction

Locate the tutorial material for exercise 1 and run the current example to inspect its flamegraph. Update the example so the tree has branches with distinctly different sizes, then rerun the exercise and confirm the flamegraph makes the memory-allocation x-axis easier to understand.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.