Open
Conversation
There was a problem hiding this comment.
Pull Request Overview
Updates the documentation for get_var_grid by removing an outdated note that grid identifiers must start at 0, since they can be any integer.
- Removed the misleading implementation note about zero-based grid IDs.
Comments suppressed due to low confidence (1)
docs/source/bmi.var_funcs.md:57
- [nitpick] Consider adding a replacement note clarifying that grid identifiers can be any integer value, e.g., 'Grid identifiers can be any integer, not necessarily starting at 0.'
-- Grid identifiers start at 0.
mdpiper
approved these changes
Jun 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've removed some wording in the description of
get_var_gridthat said grid ids start at 0. In fact, they can be any integer at all.