docs: Clarify comments in ChiselRunner: fix incomplete and misleading docstrings #10931
+2
−2
Conversation
This file contains hidden or 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
Contributor
GarmashAlex
commented
Jul 4, 2025
GarmashAlex
commented
- Completed an unfinished inline comment explaining the gas limit reset logic in the executor environment.
- Updated the docstring for the run function to remove the misleading word "Optionally," reflecting that the function always returns a tuple on success.
- These changes improve code clarity and ensure documentation accurately describes the function's behavior.
GarmashAlex
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
mattsse
approved these changes
Jul 12, 2025
mattsse
changed the title
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.