Remove text referencing scalar grid types#184
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for BMI grid functions by removing references to a "scalar" grid type, ensuring clarity on variables that do not utilize an actual grid.
- Updated wording to reflect that exchange items may not be defined on a grid.
- Removed the "scalar" grid type from the list of valid grid types.
Comments suppressed due to low confidence (1)
docs/source/bmi.grid_funcs.md:55
- Ensure that the removal of the 'scalar' grid type is consistently reflected in any related documentation or usage examples for BMI grid functions.
- `scalar`
| The functions in this section describe {ref}`model grids <model-grids>`. | ||
| In the BMI, | ||
| every {term}`exchange item` is defined on a grid, | ||
| if an {term}`exchange item` is defined on a grid, |
There was a problem hiding this comment.
Consider clarifying that not all exchange items are defined on a grid, and explicitly mention that variables without a grid will have their get_var_location return 'none'.
|
This is something that would only really be appropriate for a new major version of the standard, because it would make previously-conformant models that return |
Yeah, I should probably be merging this into the develop branch. Originally scalar variables were intended to work this way (and do for at least some BMI models) but the docs didn't reflect this. |
What was described as a "scalar" grid type in the docs was really a variable without a grid. The correct way to deal with this case is to not assign a grid to these variables (i.e. their
get_var_locationshould return"none"). None of theget_grid_functions need to be implemented for these variables.