mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
A new script then parses these json help files into the html help contents, in a standardised manner. Previously, the function help was a bunch of different formats and structures. Now, a custom stylesheet can be applied (and later tweaked!) to format these help. Eg, this commit colors variables and function names in the syntax section for greater readability.
10 lines
871 B
Plaintext
10 lines
871 B
Plaintext
{
|
|
"function": "age",
|
|
"description": "Returns the difference between two dates or datetimes.\nThe difference is returned as a <code>Interval</code> and needs to be used with one of the following functions in order to extract useful information:<br /><ul><li><code>year</code><li><code>month</code><li><code>week</code><li><code>day</code><li><code>hour</code><li><code>minute</code><li><code>second</code></ul>",
|
|
"arguments": [ {"arg":"datetime1","description":"a string, date or datetime representing the later date"},
|
|
{"arg":"datetime2","description":"a string, date or datetime representing the earlier date"}],
|
|
"examples": [ { "expression":"age('2012-05-12','2012-05-2')", "returns":"interval", "note":"use <code>day</code> to extract number of days"},
|
|
{ "expression":"day(age('2012-05-12','2012-05-2'))", "returns":"10"} ]
|
|
}
|
|
|