scaffold-eth / se-2-docs

Documentation site for Scaffold-ETH 2
https://docs.scaffoldeth.io
MIT License
13 stars 26 forks source link

Update hooks `args` and `return` values more readable #39

Closed technophile-04 closed 11 months ago

technophile-04 commented 11 months ago

Description :

Regarding useScaffoldContractRead & useScaffoldContractWrite

I think it would be really great if we link to wagmi's useContractRead return value and others args which our hooks take in and it will people know their types. Similar for useScaffoldContractWrite

Regarding useScaffoldEventHistory & useScaffoldEventSubscriber :

useScaffoldEventSubscriber is similar to wagmi's useEventSubscriber so we can add a small link to wagmi.

useScaffoldEventHistory : Screenshot 2023-11-20 at 4 02 50 PM

Maybe we describe return values in pointer so that its more easily recognized and readable ?

Pabl0cks commented 11 months ago

I'll work on a proposal tonight with those improvements 🙌