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.

Sign up for GitHub

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

Jump to bottom

feat: docs for gas-reports #64

Merged
merged 3 commits into from
Mar 1, 2022
Merged

feat: docs for gas-reports #64

merged 3 commits into from
Mar 1, 2022

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Feb 28, 2022

Fixes #31

Motivation

Epic feature needs docs

Screen Shot 2022-02-28 at 4 24 45 PM

Screenshots

Added to foundry.toml Reference

Screen Shot 2022-02-28 at 4 14 32 PM

New page: Gas reports

Screen Shot 2022-02-28 at 4 22 18 PM

rootulp
rootulp commented Feb 28, 2022
View reviewed changes
src/reference/config.md Outdated

- Type: array of strings (contract names)
- Default: ["*"]
- Environment: `FOUNDRY_GAS_REPORTS` or `DAPP_GAS_REPORTS` // TODO confirm if these exist
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

draft PR because I don't know if the env variables: FOUNDRY_GAS_REPORTS or DAPP_GAS_REPORTS exist. I don't see them in foundry-rs/foundry#637 or in Github search.

Do reviewers know if they exist? Or should I remove this line?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, they automatically exist because of this line: https://github.com/gakonst/foundry/blob/2d1713f4052cae92a178a3c8e3bacb7ad6a4e359/config/src/lib.rs#L563 😄

Copy link
Contributor Author

@rootulp rootulp Mar 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for clarifying!

onbjerg
onbjerg requested changes Mar 1, 2022
View reviewed changes
Copy link
Member

@onbjerg onbjerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should update the index in src/forge/tests.md and remove the todo, otherwise lgtm overall, thanks for this 😄

@rootulp
Copy link
Contributor Author

rootulp commented Mar 1, 2022

You should update the index in src/forge/tests.md

I don't see an index in src/forge/tests.md but I did update the index in src/forge/index.md and see this page in the sidebar. Is there another index that needs updating?

Screen Shot 2022-03-01 at 10 16 36 AM

@rootulp rootulp marked this pull request as ready for review March 1, 2022 15:18
@rootulp rootulp requested a review from onbjerg March 1, 2022 15:18
@onbjerg
Copy link
Member

onbjerg commented Mar 1, 2022

Ah, my bad, I remember it as an index. Thanks! 😄

@onbjerg onbjerg merged commit d24e785 into foundry-rs:master Mar 1, 2022
@rootulp
Copy link
Contributor Author

rootulp commented Mar 2, 2022

No problemo, thanks for maintaining these super helpful docs

@rootulp rootulp deleted the rp/gas-report branch March 2, 2022 00:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@onbjerg onbjerg Awaiting requested review from onbjerg onbjerg is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document new gas reports
2 participants
@rootulp @onbjerg