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

Documentation on outputs from function #7

Open
davecash75 opened this issue May 27, 2019 · 0 comments
Open

Documentation on outputs from function #7

davecash75 opened this issue May 27, 2019 · 0 comments

Comments

@davecash75
Copy link
Contributor

HI Pawel-
I think it would really help if you stuck in the comments at the beginning of your function definitions what they return, particularly in the cases where you are returning a dictionary with a lot of different entries. For example, the output dictionary of mmrchain. The input is really well documented, but people may also want to use stuff from the output too, especially since many people will run that function from their own script.
Thanks
Dave

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

No branches or pull requests

2 participants