-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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] Replace Truffle/web3 mentions and sample-project with Waffle/ehters #517
[docs] Replace Truffle/web3 mentions and sample-project with Waffle/ehters #517
Conversation
We should also update Typescript Support page to match the getting started config for ethers/waffle as well, right? Currently, it's written for truffle/web3 |
…-ethers-full-doc' into replace-truffle-web3-with-waffle-ethers
I worked on two different branches ( |
docs/guides/scripts.md
Outdated
``` | ||
|
||
::: tip | ||
Did you notice the double compile message? When running a script through `npx buidler run`, the `compile` task will be called before running the script, but you can skip this with the `--no-compile` parameter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is weird. If compile is running twice because the script is calling it then we should just remove that line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't remove bre.run('compile')
because it's used as example on how to use Buidler as a library making the script standalone. Maybe we could pick another task
instead of compile
to use in the sample script.
I honestly prefer compile
+ the ::: tip :::
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that, but invoking the compile
task to yield two compilations and then tell the user to use the --no-compile
arg to undo our compile
call by disabling the default behavior of compiling is just really convoluted.
@alcuadrado any thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just leave the bre.run
as a comment?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It works as an explanation and doesn't do the double compilation thing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
because the line is needed for the standalone script. Let's do this
- leave the call to
bre.run
in and simply add a step to comment it out before running the script through Buidler, explaining that that's not needed when running scripts through buidler - remove the tip block
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the tip block but left the call to bre.run
commented because the script is also mentioned on the Getting Started section. Also added a step to uncomment this line out to explain how to manually compile.
npx buidler
sample project files and code generation