docs: update gas statistics page for aggregated deployment stats#232
docs: update gas statistics page for aggregated deployment stats#232
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Updates the Hardhat gas statistics documentation to reflect the new aggregated deployment statistics format (related to hardhat#8038).
Changes:
- Updates the sample output tables to show deployment stats as aggregated Min/Average/Median/Max with
#deployments. - Updates the “Understanding the Gas Statistics Table” section to describe deployments alongside function calls.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **count**: Number of times the function was called or the contract was deployed | ||
| - **min**: Minimum gas consumed in a single call | ||
| - **max**: Maximum gas consumed in a single call | ||
| - **avg**: Average gas consumed across all calls | ||
| - **median**: Median gas consumed across all calls |
There was a problem hiding this comment.
The metric definitions still describe only function calls (e.g., “in a single call” / “across all calls”), but this section now says the table includes deployments too. Please update these bullets to describe both (e.g., call or deployment) and align the naming with the table headers (#calls vs #deployments) so readers aren’t confused about what “count” refers to for deployments.
| - **count**: Number of times the function was called or the contract was deployed | |
| - **min**: Minimum gas consumed in a single call | |
| - **max**: Maximum gas consumed in a single call | |
| - **avg**: Average gas consumed across all calls | |
| - **median**: Median gas consumed across all calls | |
| - **count**: For functions, the number of calls (`#calls`); for deployments, the number of times the contract was deployed (`#deployments`) | |
| - **min**: Minimum gas consumed in a single call or deployment | |
| - **max**: Maximum gas consumed in a single call or deployment | |
| - **avg**: Average gas consumed across all calls or deployments | |
| - **median**: Median gas consumed across all calls or deployments |
Related to NomicFoundation/hardhat#8038