Dox clarification
MichaelChirico opened this issue · comments
In ?GridTopology
, we have:
cellcentre.offset
numeric
; vector with the smallest coordinates for each dimension
To me, this reads as cellcentre.offset
is the lower-left corner of the output grid;
In fact, it's the lower-left centroid of the output grid.
This indeed jives with the documentation as stands, since coordinates(grid)
will return the lower-left centroid.
However I think it would be helpful to add a short note about this distinction in the documentation, e.g.,
cellcentre.offset
numeric
; vector with the smallest centroid coordinates for each dimension
Where does your terminology come from? I see, in the same sentence, that coordinates refer to cell center. How much clearer can it get? Anyway, I added "centroid" upon your wish.
Oh -- I'm running 1.2-3. That phrasing is new. I should have checked the development version. Thank you.
You're right, we were looking at different documentation objects; fixed the other one too.