chore[docs]: mention the --venom flag in venom docs
#4353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vyper/venom/README.md
Outdated
| @@ -193,7 +193,7 @@ An operand can be a label, a variable, or a literal. | |||
| By convention, variables have a `%-` prefix, e.g. `%1` is a valid variable. However, the prefix is not required. | |||
|
|
|||
| ## Instructions | |||
| To enable Venom IR in Vyper, use the `--experimental-codegen` flag. To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. | |||
| To enable Venom IR in Vyper, use the `--venom` or `--experimental-codegen` CLI flag, or the corresponding pragma statements. To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. | |||
There was a problem hiding this comment.
Suggested change
| To enable Venom IR in Vyper, use the `--venom` or `--experimental-codegen` CLI flag, or the corresponding pragma statements. To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. | |
| To enable Venom IR in Vyper, use the `--experimental-codegen` CLI flag or its alias `--venom`, or the corresponding pragma statements. To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. |
There was a problem hiding this comment.
Suggested change
| To enable Venom IR in Vyper, use the `--venom` or `--experimental-codegen` CLI flag, or the corresponding pragma statements. To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. | |
| To enable Venom IR in Vyper, use the `--experimental-codegen` CLI flag or its alias `--venom`, or the corresponding pragma statements (e.g. `#pragma experimental-codegen`). To view the Venom IR output, use `-f bb_runtime` for the runtime code, or `-f bb` to see the deploy code. To get a dot file (for use e.g. with `xdot -`), use `-f cfg` or `-f cfg_runtime`. |
|
I think we should also update the rst docs |
sandbubbles
changed the title
--venom flag in venom docs--venom flag in venom docs
I've added a mention of pragma and CLI options for venom. |
pcaversaccio
reviewed
Nov 9, 2024
docs/compiling-a-contract.rst
Outdated
| Enabling Experimental Codegen | ||
| =========================== | ||
|
|
||
| When compiling, you can use the CLI flag ``"experimental-codegen"`` or its alias ``"venom"`` to activate the new Venom IR. |
There was a problem hiding this comment.
Suggested change
| When compiling, you can use the CLI flag ``"experimental-codegen"`` or its alias ``"venom"`` to activate the new Venom IR. | |
| When compiling, you can use the CLI flag ``"experimental-codegen"`` or its alias ``"venom"`` to activate the new `Venom IR <https://github.com/vyperlang/vyper/blob/master/vyper/venom/README.md>`_. |
There was a problem hiding this comment.
I just realised that when I printed vyper --help the Venom flags bb, bb_runtime, cfg, and cfg_runtime are missing. Furthermore, they are also missing here:
I think it would be useful to have them in the CLI help as well as in the docs.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4353 +/- ##
==========================================
- Coverage 91.37% 88.89% -2.49%
==========================================
Files 112 112
Lines 15927 15927
Branches 2693 2693
==========================================
- Hits 14554 14159 -395
- Misses 939 1258 +319
- Partials 434 510 +76 ☔ View full report in Codecov by Sentry. |
pcaversaccio
approved these changes
Nov 10, 2024
charles-cooper
approved these changes
Nov 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Add one sentence about
--venomand the corresponding pragma.How I did it
How to verify it
Commit message
Description for the changelog
Cute Animal Picture