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

Improve API documentation #2

Open
adammoody opened this issue Aug 22, 2019 · 0 comments
Open

Improve API documentation #2

adammoody opened this issue Aug 22, 2019 · 0 comments

Comments

@adammoody
Copy link
Contributor

The ER README.md points users to er.h for usage info, but documentation in that file is currently lacking. We should say which ER functions are collective. For collective functions, we should say which group of processes must call the function, and we should say whether the return code is the same on all procs or not. More description should be provided for input parameters, including adding text showing example calls.

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

1 participant