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 example / error in documentation #150

Open
hiker opened this issue Dec 9, 2024 · 0 comments
Open

Add example / error in documentation #150

hiker opened this issue Dec 9, 2024 · 0 comments

Comments

@hiker
Copy link

hiker commented Dec 9, 2024

It would be great to have an executable example, so it makes it easier to see what is happening, and what needs to be done to a code. I am aware that they are tests, but see #149.

I also believe there is a mistake in the documentation. The file documentation./Sphinx/user_guide/api.rst contains:

./Sphinx/user_guide/api.rst:   integer (kind=pik) :: vernier_handle

I don't see pik defined anywhere:

~/work/vernier$ grep -ir pik 
grep: .git/objects/pack/pack-cdf4447b72218c052ac5474be4c5f4d464fc3610.pack: binary file matches
documentation/Sphinx/user_guide/api.rst:   integer (kind=pik) :: vernier_handle

Is that supposed to be vik?

src/f/vernier_mod.F90:  integer, public, parameter :: vik = c_long

?

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