Clarify compiler optimization warning

pull/420/head
cgewecke 5 years ago committed by GitHub
parent d359df2cea
commit a43ee6553e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      README.md

@ -36,8 +36,7 @@ truffle run coverage [command-options]
+ Coverage launches its own in-process ganache server.
+ You can set [ganache options][1] using the `providerOptions` key in your `.solcover.js` [config][15].
+ Coverage [distorts gas consumption][13]. Tests that check exact gas consumption should be [skipped][24].
+ Coverage runs your compiler with **optimization off**.
+ :warning: Please report all unexpected compilation faults to issue #417 :warning:
+ :warning: Contracts are compiled **without optimization**. Please report unexpected compilation faults to [issue 417][25]
## Command Options
| Option <img width=200/> | Example <img width=750/>| Description <img width=1000/> |
@ -152,3 +151,4 @@ $ yarn
[22]: https://cdn-images-1.medium.com/max/800/1*uum8t-31bUaa6dTRVVhj6w.png
[23]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#workflow-hooks
[24]: https://github.com/sc-forks/solidity-coverage/blob/beta/docs/advanced.md#skipping-tests
[25]: https://github.com/sc-forks/solidity-coverage/issues/417

Loading…
Cancel
Save