-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: bump motsu v0.4.0 #39
Conversation
# Conflicts: # Cargo.toml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have a warning to solve:
Check warning on line 265 in crates/motsu/src/lib.rs
unused variable: `pong`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not in favor of using contracts from our unit tests in this README, as I find those contracts too unclear to be used to explain how Motsu works. A contract used for docs should be simple, yet meaningful, and Proxy
is not really meaningful.
A good example of simple and meaningful tests would be the ping_pong_tests
. But I'd advise against using even these tests as part of our docs, as they're not versatile enough (e.g. they don't use msg::value
).
Ideally, we would define one or two contracts separate from unit tests, place those at the top of README(s), and then reuse these contracts for all subsequent code examples. This would both make it easier for readers to follow and understand our explanations, while making it unnecessary to specify imports in each example. I think neither ERC20
nor Proxy
nor Ping/Pong
are good candidates for this, and new contracts are necessary.
Let me know if you'd like me to suggest contracts for the docs, and I can take some time to think of good examples.
EDIT: if we updated Ping/Pong
contracts to accept ether and pass it to each other, it would make them more valid examples for use in docs, as it would make sense to use .sender_and_value(...)
.
Alternatively, if the docs aren't high priority for this PR, we can keep using current contracts in READMEs, but create a separate issue to update our docs for some future release.
Wdyt @bidzyyys @qalisander ?
I believe we can take Counter example, as I believe it is auto generated by default from |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work!
The |
Update changelog date |
# Conflicts: # crates/motsu/src/lib.rs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
PR Checklist