Skip to content
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

Legacy documentation in The Crowdfunding Smart Contract (part 2) #422

Open
borisghidaglia opened this issue Aug 21, 2022 · 1 comment
Open

Comments

@borisghidaglia
Copy link

Hello,

The commit 22a3b8e introduced an inconsistency between the fund function implementation and its explanation below in the doc.

The commit removes the #[payment_amount] payment: BigUint argument in the fund function, but does not modify the text below it accordingly. Thus, the doc talks about the argument when it does not exist in the code anymore:

Notice the #[payment_amount] payment: BigUint argument. This is not a real argument, but just syntactic sugar to pass the paid sum to the function.

I did not investigated further to see if other inconsistencies exist on the page, but I figured it could be useful to signal this, just so that it is written somewhere :)


By the way, I tried to look for a documentation about #[payment_amount] for the payable annotation, but did not find it. Did I miss something?

Thank you very much!

@andrei-marinica
Copy link
Contributor

It's still supported in the framework, but we realized it brings more confusion than benefits, so we discourage its use.

Thanks for picking that up, we will fix the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants