Tweaks to documentation comments for user-facing Grist functions (#126)

- Update internal links in function documentation
- Remove emphasis in code blocks
- Remove trailing whitespace
This commit is contained in:
Dmitry 2022-02-13 00:45:24 -05:00 committed by GitHub
parent 2611d05c39
commit 25b7e6c245
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 21 deletions

View File

@ -863,8 +863,8 @@ def UUID():
"""
Generate a random UUID-formatted string identifier.
Since UUID() produces a different value each time it's called, it is best to use it in
[trigger formula](https://support.getgrist.com/formulas/#trigger-formulas) for new records.
This would only calculate UUID() once and freeze the calculated value. By contrast, a regular [formula]
[trigger formula](formulas.md#trigger-formulas) for new records.
This would only calculate UUID() once and freeze the calculated value. By contrast, a regular formula
may get recalculated any time the document is reloaded, producing a different value for UUID() each time.
"""
if six.PY2:

View File

@ -222,7 +222,7 @@ def LEN(text):
"""
Returns the number of characters in a text string, or the number of items in a list. Same as
[`len`](https://docs.python.org/3/library/functions.html#len) in python.
See [Record Set](https://support.getgrist.com/functions/#recordset) for an example of using `len` on a list of records.
See [Record Set](#recordset) for an example of using `len` on a list of records.
>>> LEN("Phoenix, AZ")
11

View File

@ -38,7 +38,7 @@ class Record(object):
Name: $group, rec.group
Usage: __$group__
In a [summary table](https://support.getgrist.com/summary-tables/), `$group` is a special field
In a [summary table](summary-tables.md), `$group` is a special field
containing the list of Records that are summarized by the current summary line. E.g. the formula
`len($group)` counts the number of those records being summarized in each row.

View File

@ -81,16 +81,16 @@ class UserTable(object):
"""
Name: lookupRecords
Usage: UserTable.__lookupRecords__(Field_In_Lookup_Table=value, ...)
Returns a RecordSet matching the given field=value arguments. The value may be any expression,
Returns a [RecordSet](#recordset) 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"`) (examples below).
If `sort_by=field` is given, sort the results by that field.
For example:
```
People.*lookupRecords*(Email=$Work_Email)
People.*lookupRecords*(First_Name="George", Last_Name="Washington")
People.*lookupRecords*(Last_Name="Johnson", sort_by="First_Name")
People.lookupRecords(Email=$Work_Email)
People.lookupRecords(First_Name="George", Last_Name="Washington")
People.lookupRecords(Last_Name="Johnson", sort_by="First_Name")
```
See [RecordSet](#recordset) for useful properties offered by the returned object.
@ -105,15 +105,15 @@ class UserTable(object):
"""
Name: lookupOne
Usage: UserTable.__lookupOne__(Field_In_Lookup_Table=value, ...)
Returns a Record matching the given field=value arguments. The value may be any expression,
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.
For example:
```
People.*lookupOne*(First_Name="Lewis", Last_Name="Carroll")
People.*lookupOne*(Email=$Work_Email)
People.lookupOne(First_Name="Lewis", Last_Name="Carroll")
People.lookupOne(Email=$Work_Email)
```
"""
return self.table.lookup_one_record(**field_value_pairs)