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.
12 lines
810 B
Plaintext
12 lines
810 B
Plaintext
{
|
|
"function": "levenshtein",
|
|
"description": "Returns the Levenshtein edit distance between two strings. This equates to the minimum number of character edits (insertions, deletions or substitutions) required to change one string to another.<br />The Levenshtein distance is a measure of the similarity between two strings. Smaller distances mean the strings are more similar, and larger distances indicate more different strings. The distance is case sensitive.",
|
|
"arguments": [ {"arg":"string1","description":"a string"},
|
|
{"arg":"string2","description":"a string"}
|
|
],
|
|
"examples": [ { "expression":"levenshtein('kittens','mitten')", "returns":"2"},
|
|
{ "expression":"levenshtein('Kitten','kitten')", "returns":"1"},
|
|
{ "expression":"levenshtein(upper('Kitten'),upper('kitten'))", "returns":"0"}
|
|
]
|
|
}
|