clarify interpretation of less and greater as before/after #461
Conversation
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
help/en/docs/functions.md
Outdated
| - __`ge`__: (greater than or equal to) find nearest record with sort values >= the given values | ||
| - __`eq`__: (equal to) find nearest record with sort values == the given values | ||
| - __`lt`__: (less than) find nearest (last) record with sort values < (before) the given values | ||
| - __`le`__: (less than or equal to) find nearest record with sort values <= (last before or first equal) the given values |
There was a problem hiding this comment.
I think it should actually be "last that's before or equal" -- if you have multiple equal values to the one you are looking up, it should return the last of these.
There was a problem hiding this comment.
Feel free to edit this PR to so the phrasing is more accurate. I was just pointing out that it wasn't clear to without these details. If it feels cleaner to you, maybe you could these alternative explanations somewhere else and link to that.
help/en/docs/functions.md
Outdated
| - __`lt`__: (less than) find nearest (last) record with sort values < (before) the given values | ||
| - __`le`__: (less than or equal to) find nearest record with sort values <= (last before or first equal) the given values | ||
| - __`gt`__: (greater than) find nearest (first) record with sort values > (after) the given values | ||
| - __`ge`__: (greater than or equal to) find nearest (first) record with sort values >= (equal or after) the given values |
There was a problem hiding this comment.
this one should be "first equal or after", though I think this is clear as is. Maybe le can be phrased the same way.
dsagal
force-pushed
the
feature/le-ge-as-before-after
branch
from
1c829f3 to
e53a3c0
Compare
|
Sorry to be slow. I think the extra explanation paragraph you added clarifies things nicely, so I simplified a bit the editing of the individual methods. If it looks good to you, I'll merge in. Preview here. |
There was a problem hiding this comment.
Made some updates to the formatting (capitalization, punctuation) to match formatting of list found here: https://deploy-preview-461--grist-help-preview.netlify.app/functions/#datedif
Added filler words because the existing phrasing requires the reader to mentally fill in gaps, making it harder to process. Since the concept is already a bit complex, including these filler words makes it easier to understand at a glance.
help/en/docs/functions.md
Outdated
| - __`lt`__: ("less than") find nearest (last) record with sort values before the given values | ||
| - __`le`__: ("less than or equal to") find last record with sort values equal to or before | ||
| the given values | ||
| - __`gt`__: ("greater than") find nearest (first) record with sort values after the given values | ||
| - __`ge`__: ("greater than or equal to") find first record with sort values equal to or after | ||
| the given values | ||
| - __`eq`__: ("equal to") find the first record with sort values equal to the given values |
There was a problem hiding this comment.
| - __`lt`__: ("less than") find nearest (last) record with sort values before the given values | |
| - __`le`__: ("less than or equal to") find last record with sort values equal to or before | |
| the given values | |
| - __`gt`__: ("greater than") find nearest (first) record with sort values after the given values | |
| - __`ge`__: ("greater than or equal to") find first record with sort values equal to or after | |
| the given values | |
| - __`eq`__: ("equal to") find the first record with sort values equal to the given values | |
| - __`lt`__: ("less than") Finds the nearest (last) record where the sort values are **before** the given values. | |
| - __`le`__: ("less than or equal to") Finds the last record where the sort values are **equal to or before** | |
| the given values. | |
| - __`gt`__: ("greater than") Finds the nearest (first) record where the sort values are **after** the given values. | |
| - __`ge`__: ("greater than or equal to") Finds the first record where the sort values are **equal to or after** | |
| the given values. | |
| - __`eq`__: ("equal to") Finds the first record where the sort values are **equal to** the given values. |
I welcome edits / rephrasing. This is just the simplest change to make it clear to me, but it might only muddle it for others.
There might also be other places this clarification should be made - IDK.