Skip to content

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

Merged
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
gmao-cda:docfix/cda/grid_indexing
Apr 8, 2025
Merged

Fix the incorrect index for v-point in the doc#876
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
gmao-cda:docfix/cda/grid_indexing

Conversation

@gmao-cda
Copy link
Copy Markdown

@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
Copy Markdown
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
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