mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
709c14391b
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.
11 lines
766 B
Plaintext
11 lines
766 B
Plaintext
{
|
|
"function": "wordwrap",
|
|
"description": "Returns a string wrapped to a maximum/minimum number of characters.",
|
|
"arguments": [ {"arg":"string","description":"the string to be wrapped"},
|
|
{"arg":"wrap_length","description":"an integer. If wrap_length is positive the number represents the ideal maximum number of characters to wrap; if negative, the number represents the minimum number of characters to wrap."},
|
|
{"arg":"delimiter_string","description":"the delimiter string to wrap to a new line (optional)."}
|
|
],
|
|
"examples": [ { "expression":"wordwrap('UNIVERSITY OF QGIS',13)", "returns":"'UNIVERSITY OF\nQGIS'"},
|
|
{ "expression":"wordwrap('UNIVERSITY OF QGIS',-3)", "returns":"'UNIVERSITY\nOF QGIS'"} ]
|
|
}
|