QGIS/resources/function_help/json/round

{
  "name": "round",
  "type": "function",
  "description": "Rounds a number to number of decimal places.",
  "arguments": [
	{"arg":"value","description":"decimal number to be rounded"},
	{"arg":"places","optional":true,"default":"0","description":"Optional integer representing number of places to round decimals to. Can be negative."}
  ],
  "examples": [
	{ "expression":"round(1234.567, 2)", "returns":"1234.57"},
	{ "expression":"round(1234.567)", "returns":"1235"}
  ]
}
Change expression help from free form html files to structured json 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. 2015-06-11 12:02:27 +10:00			`{`
move remaining function_help to json and update it's translation handling 2015-09-20 17:12:43 +02:00			`"name": "round",`
			`"type": "function",`
Change expression help from free form html files to structured json 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. 2015-06-11 12:02:27 +10:00			`"description": "Rounds a number to number of decimal places.",`
move remaining function_help to json and update it's translation handling 2015-09-20 17:12:43 +02:00			`"arguments": [`
[FEATURE] Allow expression functions to use named parameters This commit sets the framework for allowing expression functions to use named parameters. Ie, instead of: clamp(1,2,3) you can use: clamp( min:=1, value:=2, max:=3) This also allows arguments to be switched, eg: clamp( value:=2, max:=3, min:=1) Additionally, it allows for a more structured definition of function parameters to handle optional arguments and default values for parameters. These are currently being done using a hacky infinite argument list. I've utilised the postgres ':=' syntax for specifying named arguments to avoid potential collisions which may arise with the equality test if we re-used just the '=' operator alone. Sponsored by North Road 2016-03-29 16:22:04 +11:00			`{"arg":"value","description":"decimal number to be rounded"},`
			`{"arg":"places","optional":true,"default":"0","description":"Optional integer representing number of places to round decimals to. Can be negative."}`
move remaining function_help to json and update it's translation handling 2015-09-20 17:12:43 +02:00			`],`
			`"examples": [`
			`{ "expression":"round(1234.567, 2)", "returns":"1234.57"},`
			`{ "expression":"round(1234.567)", "returns":"1235"}`
			`]`
Change expression help from free form html files to structured json 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. 2015-06-11 12:02:27 +10:00			`}`