lookup-one-text-change #337
Open
Conversation
This file contains 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
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
MichaelNickolas
commented
Apr 30, 2024
dsagal
reviewed
May 1, 2024
help/en/docs/functions.md
Outdated
| @@ -138,8 +138,7 @@ sum(r.Population for r in Countries.all) | |||
| </summary> | |||
| Returns a [Record](#record) matching the given field=value arguments. The value may be any expression, | |||
| most commonly a field in the current row (e.g. `$SomeField`) or a constant (e.g. a quoted string | |||
| like `"Some Value"`). If multiple records match, returns one of them. If none match, returns the | |||
| special empty record. If `sort_by=field` is given, sort the results by that field. | |||
| like `"Some Value"`). If multiple records are found, the first match is returned. You may set the optional sort_by parameter to the column ID by which to sort multiple matching results, to determine which of them is returned. You can prefix the column ID with "-" to reverse the order. | |||
There was a problem hiding this comment.
Could you add backticks around the sort_by parameter name? It would cause this name to appear as code style in the documentation.
Also, I notice there is no link to the longer article, i.e. https://support.getgrist.com/references-lookups/#lookupone (you would add it as [some description...](references-lookups.md#lookupone))
Similarly, it would be nice to include a link to https://support.getgrist.com/references-lookups/#lookuprecords ([some description...](references-lookups.md#lookuprecords)) into the documentation of lookupRecords.
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.
Inputting... "If multiple records are found, the first match is returned. You may set the optional sort_by parameter to the column ID by which to sort multiple matching results, to determine which of them is returned. You can prefix the column ID with "-" to reverse the order."
...in the lookupOne function description.