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

Add returnParameters in SourceContractItem alongside with parameters #300

Open
Pzixel opened this issue Jun 10, 2021 · 3 comments
Open

Add returnParameters in SourceContractItem alongside with parameters #300

Pzixel opened this issue Jun 10, 2021 · 3 comments

Comments

@Pzixel
Copy link

Pzixel commented Jun 10, 2021

Current version of solidity-docgen exposes ast.parameters as args but doesn't expose return values. It's important because natspec.returns only shows return args that were documented which isn't always the case.

It may be worthwhile to expose this.astNode itself so users can always access what they need from solc output.

@Pzixel Pzixel changed the title Add returnParameters alongside with parameters Add returnParameters in SourceContractItem alongside with parameters Jun 10, 2021
@frangio
Copy link
Contributor

frangio commented Jun 10, 2021

Exposing return parameters is a good idea.

astNode is a private TypeScript variable but you should still be able to access it in your Handlebars templates. Can you try that and let me know if it works?

@Pzixel
Copy link
Author

Pzixel commented Jun 10, 2021

I'l give it a shot. Thanks for insight, in my actually work

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

3 participants
@frangio @Pzixel and others