Skip to content

Fix the incorrect index for v-point in the doc #876

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

Merged
merged 2 commits into from
Apr 8, 2025

Conversation

gmao-cda
Copy link

@gmao-cda gmao-cda commented Apr 7, 2025

This tiny PR fix some typos in the MOM6 documentation when illustrating the index for v-point.

The current doc with the typo is at (https://mom6.readthedocs.io/en/main/api/generated/pages/Horizontal_Indexing.html)

Under Section "Soft convention for loop variables", the reference for v-point is incorrect. See the screenshot here:
Screenshot 2025-04-07 at 12 08 18 PM

The later one should be v(i,J-1) and \f$v_{i,j-\frac{1}{2}}\f$

As suggested by @marshallward , Submit PR here instead of the repo mom-ocean

Copy link
Member

@Hallberg-NOAA Hallberg-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for these corrections to the documentation.

@marshallward marshallward merged commit 084a5db into NOAA-GFDL:dev/gfdl Apr 8, 2025
10 checks passed
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

Successfully merging this pull request may close these issues.

3 participants