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

Fortran documentation out-of -date #2474

Closed
hr87 opened this issue Sep 29, 2020 · 2 comments
Closed

Fortran documentation out-of -date #2474

hr87 opened this issue Sep 29, 2020 · 2 comments

Comments

@hr87
Copy link

hr87 commented Sep 29, 2020

Describe the bug
The Fortran documentation is lacking descriptions for several routines. The one I found missing is adios2_attribute_data. Furthermore, it seems like the documentation for adios2_set_steps_selection is actually for the wrong method. Additionally, the description for the latter is not clear in the C++ section either.

To Reproduce

  1. Go to the documentation
  2. Look for adios2_attribute_data

Expected behavior
Find a clear description of method

@williamfgc
Copy link
Contributor

@hr87 thanks for pointing this out. Yes, the Fortran docs are a bit of a pain to maintain since they are not automatically handled by readthedocs + breathe + doxygen (same with tests, there is currently no testing framework, but just assert style checks). It's the hassle of mixing Fortran and modern infrastructure. Fortran bindings are essentially (almost) replicating the C bindings (those are automatically handled), check the docs for adios2_set_steps_selection. Also, since adios2 relies on its community members, feel free to do a PR at anytime since all of the documentation source code resides under docs in particular Fortran full APIs.

@dmitry-ganyushin
Copy link
Contributor

dmitry-ganyushin commented Dec 22, 2020

Documentation is updated with PR #2559

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