Docs: Improve Accessors and Manager contracts documentation #507
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
mmv08
force-pushed
the
docs/improve-natspec-docs
branch
from
b49fd97 to
becf156
Compare
mmv08
commented
Feb 15, 2023
| "prettier": "^2.8.3", | ||
| "prettier-plugin-solidity": "1.1.1", | ||
| "prettier": "^2.8.4", | ||
| "prettier-plugin-solidity": "1.1.2", |
There was a problem hiding this comment.
keeping the formatters up-to-date in case there are any improvements for docs n code formatting
Pull Request Test Coverage Report for Build 4193190861
💛 - Coveralls |
mmv08
force-pushed
the
docs/improve-natspec-docs
branch
2 times, most recently
from
8828a42 to
0e1a44f
Compare
rmeissner
reviewed
Feb 16, 2023
| /// @author Richard Meissner - <[email protected]> | ||
| /** | ||
| * @title Simulate Transaction Accessor. | ||
| * @notice Can be used with StorageAccessible to simulate Safe transactions. |
There was a problem hiding this comment.
I had an internal debate on this one. I reasoned that the end user of this particular contract is a developer, so notice is the way to go. Also, the docs mention that @dev is for extra details and we have none
rmeissner
reviewed
Feb 16, 2023
contracts/base/ModuleManager.sol
Outdated
| /// @param data Data payload of module transaction. | ||
| /// @param operation Operation type of module transaction. | ||
| /** | ||
| * @notice Execute `operation` (0: Call, 1: DelegateCall) to `to` with `data` and `value` (Native Token) |
There was a problem hiding this comment.
should we have the full data in here? might be quite long ... but not sure what a good alternative would be. At least I would exchange value and data in the text to avoid that the value gets lost after a long data.
rmeissner
approved these changes
Feb 16, 2023
mmv08
force-pushed
the
docs/improve-natspec-docs
branch
from
0e1a44f to
cc348ed
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR:
accessors/andbase/by