Fix code-block directive in struct docs #2422
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
The documentation is currently [missing a code example on how to define structs](https://vyper.readthedocs.io/en/stable/types.html#structs). That's because the `code-block` RST directive is missing a language argument. This PR fixes it.
Codecov Report
@@ Coverage Diff @@
## master #2422 +/- ##
=======================================
Coverage 85.47% 85.47%
=======================================
Files 91 91
Lines 9027 9027
Branches 2151 2151
=======================================
Hits 7716 7716
Misses 806 806
Partials 505 505 Continue to review full report at Codecov.
|
charles-cooper
approved these changes
Aug 17, 2021
There was a problem hiding this comment.
LGTM. I noticed the example itself is slightly wrong -- 2 is not a valid value for the value2 field, it should be 2.0. @milancermak would you be open to fixing that as well?
Merged
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.
The documentation is currently missing a code example on how to define structs. That's because the
code-blockRST directive is missing a language argument. This PR fixes it.