Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(forge test): improve description of --flamechart and --flamegraph, explaining the difference #8914

Closed
zerosnacks opened this issue Sep 20, 2024 · 0 comments · Fixed by #8917
Labels
A-docs Area: docs first issue A good way to start contributing

Comments

@zerosnacks
Copy link
Member

zerosnacks commented Sep 20, 2024

Component

Forge

Describe the feature you would like

The current description is not very descriptive

$ forge test --help

      --flamegraph
          Generate a flamegraph for a single test. Implies `--decode-internal`

      --flamechart
          Generate a flamechart for a single test. Implies `--decode-internal`

A flame graph is used to visualize which functions or operations within the smart contract are consuming the most gas overall in a sorted manner.

A flame chart shows the gas usage over time, illustrating when each function is called (execution order) and how much gas it consumes at each point in the timeline.

In both cases the measured value is gas consumption

The note about implies --decode-internal should persist

cc @zemse please correct me if I'm wrong

Additional context

Follow up of #8640

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: docs first issue A good way to start contributing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant