diff options
Diffstat (limited to 'data/docs.json')
| -rw-r--r-- | data/docs.json | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/data/docs.json b/data/docs.json index 5a6b1722d..620aeb179 100644 --- a/data/docs.json +++ b/data/docs.json @@ -3033,11 +3033,11 @@ }, "compare": { "Conditional": { - "Description": "Conditional can be used as a ternary operator.\nIt returns a if condition, else b.", + "Description": "Conditional can be used as a ternary operator.\n\nIt returns v1 if cond is true, else v2.", "Args": [ - "condition", - "a", - "b" + "cond", + "v1", + "v2" ], "Aliases": [ "cond" @@ -3050,10 +3050,10 @@ ] }, "Default": { - "Description": "Default checks whether a given value is set and returns a default value if it\nis not. \"Set\" in this context means non-zero for numeric types and times;\nnon-zero length for strings, arrays, slices, and maps;\nany boolean or struct value; or non-nil for any other types.", + "Description": "Default checks whether a givenv is set and returns the default value defaultv if it\nis not. \"Set\" in this context means non-zero for numeric types and times;\nnon-zero length for strings, arrays, slices, and maps;\nany boolean or struct value; or non-nil for any other types.", "Args": [ - "dflt", - "given" + "defaultv", + "givenv" ], "Aliases": [ "default" @@ -3154,10 +3154,10 @@ }, "collections": { "After": { - "Description": "After returns all the items after the first N in a rangeable list.", + "Description": "After returns all the items after the first n items in list l.", "Args": [ - "index", - "seq" + "n", + "l" ], "Aliases": [ "after" @@ -3165,7 +3165,7 @@ "Examples": [] }, "Append": { - "Description": "Append appends the arguments up to the last one to the slice in the last argument.\nThis construct allows template constructs like this:\n {{ $pages = $pages | append $p2 $p1 }}\nNote that with 2 arguments where both are slices of the same type,\nthe first slice will be appended to the second:\n {{ $pages = $pages | append .Site.RegularPages }}", + "Description": "Append appends args up to the last one to the slice in the last argument.\nThis construct allows template constructs like this:\n\n\t{{ $pages = $pages | append $p2 $p1 }}\n\nNote that with 2 arguments where both are slices of the same type,\nthe first slice will be appended to the second:\n\n\t{{ $pages = $pages | append .Site.RegularPages }}", "Args": [ "args" ], @@ -3175,10 +3175,10 @@ "Examples": [] }, "Apply": { - "Description": "Apply takes a map, array, or slice and returns a new slice with the function fname applied over it.", + "Description": "Apply takes a map, array, or slice c and returns a new slice with the function fname applied over it.", "Args": [ "ctx", - "seq", + "c", "fname", "args" ], @@ -3188,9 +3188,9 @@ "Examples": [] }, "Complement": { - "Description": "Complement gives the elements in the last element of seqs that are not in\nany of the others.\nAll elements of seqs must be slices or arrays of comparable types.\n\nThe reasoning behind this rather clumsy API is so we can do this in the templates:\n {{ $c := .Pages | complement $last4 }}", + "Description": "Complement gives the elements in the last element of ls that are not in\nany of the others.\n\nAll elements of ls must be slices or arrays of comparable types.\n\nThe reasoning behind this rather clumsy API is so we can do this in the templates:\n\n\t{{ $c := .Pages | complement $last4 }}", "Args": [ - "seqs" + "ls" ], "Aliases": [ "complement" @@ -3203,10 +3203,10 @@ ] }, "Delimit": { - "Description": "Delimit takes a given sequence and returns a delimited HTML string.\nIf last is passed to the function, it will be used as the final delimiter.", + "Description": "Delimit takes a given list l and returns a string delimited by sep.\nIf last is passed to the function, it will be used as the final delimiter.", "Args": [ - "seq", - "delimiter", + "l", + "sep", "last" ], "Aliases": [ @@ -3220,7 +3220,7 @@ ] }, "Dictionary": { - "Description": "Dictionary creates a map[string]interface{} from the given parameters by\nwalking the parameters and treating them as key-value pairs. The number\nof parameters must be even.\nThe keys can be string slices, which will create the needed nested structure.", + "Description": "Dictionary creates a new map from the given parameters by\ntreating values as key-value pairs. The number of values must be even.\nThe keys can be string slices, which will create the needed nested structure.", "Args": [ "values" ], @@ -3230,10 +3230,10 @@ "Examples": [] }, "EchoParam": { - "Description": "EchoParam returns a given value if it is set; otherwise, it returns an\nempty string.", + "Description": "EchoParam returns a the value in the collection c with key k if is set; otherwise, it returns an\nempty string.", "Args": [ - "a", - "key" + "c", + "k" ], "Aliases": [ "echoParam" @@ -3246,10 +3246,10 @@ ] }, "First": { - "Description": "First returns the first N items in a rangeable list.", + "Description": "First returns the first limit items in list l.", "Args": [ "limit", - "seq" + "l" ], "Aliases": [ "first" @@ -3257,7 +3257,7 @@ "Examples": [] }, "Group": { - "Description": "Group groups a set of elements by the given key.\nThis is currently only supported for Pages.", + "Description": "Group groups a set of items by the given key.\nThis is currently only supported for Pages.", "Args": [ "key", "items" @@ -3268,7 +3268,7 @@ "Examples": [] }, "In": { - "Description": "In returns whether v is in the set l. l may be an array or slice.", + "Description": "In returns whether v is in the list l. l may be an array or slice.", "Args": [ "l", "v" @@ -3284,7 +3284,7 @@ ] }, "Index": { - "Description": "Index returns the result of indexing its first argument by the following\narguments. Thus \"index x 1 2 3\" is, in Go syntax, x[1][2][3]. Each\nindexed item must be a map, slice, or array.\n\nCopied from Go stdlib src/text/template/funcs.go.\n\nWe deviate from the stdlib due to https://github.com/golang/go/issues/14751.\n\nTODO(moorereason): merge upstream changes.", + "Description": "Index returns the result of indexing its first argument by the following\narguments. Thus \"index x 1 2 3\" is, in Go syntax, x[1][2][3]. Each\nindexed item must be a map, slice, or array.\n\nAdapted from Go stdlib src/text/template/funcs.go.\n\nWe deviate from the stdlib mostly because of https://github.com/golang/go/issues/14751.", "Args": [ "item", "args" @@ -3306,9 +3306,9 @@ "Examples": [] }, "IsSet": { - "Description": "IsSet returns whether a given array, channel, slice, or map has a key\ndefined.", + "Description": "IsSet returns whether a given array, channel, slice, or map in c has the given key\ndefined.", "Args": [ - "a", + "c", "key" ], "Aliases": [ @@ -3321,7 +3321,7 @@ "Description": "KeyVals creates a key and values wrapper.", "Args": [ "key", - "vals" + "values" ], "Aliases": [ "keyVals" @@ -3334,10 +3334,10 @@ ] }, "Last": { - "Description": "Last returns the last N items in a rangeable list.", + "Description": "Last returns the last limit items in the list l.", "Args": [ "limit", - "seq" + "l" ], "Aliases": [ "last" @@ -3345,7 +3345,7 @@ "Examples": [] }, "Merge": { - "Description": "Merge creates a copy of the final parameter and merges the preceding\nparameters into it in reverse order.\nCurrently only maps are supported. Key handling is case insensitive.", + "Description": "Merge creates a copy of the final parameter in params and merges the preceding\nparameters into it in reverse order.\n\nCurrently only maps are supported. Key handling is case insensitive.", "Args": [ "params" ], @@ -3381,7 +3381,7 @@ ] }, "Querify": { - "Description": "Querify encodes the given parameters in URL-encoded form (\"bar=baz\u0026foo=quux\") sorted by key.", + "Description": "Querify encodes the given params in URL-encoded form (\"bar=baz\u0026foo=quux\") sorted by key.", "Args": [ "params" ], @@ -3410,7 +3410,7 @@ "Examples": null }, "Seq": { - "Description": "Seq creates a sequence of integers. It's named and used as GNU's seq.\n\nExamples:\n 3 =\u003e 1, 2, 3\n 1 2 4 =\u003e 1, 3\n -3 =\u003e -1, -2, -3\n 1 4 =\u003e 1, 2, 3, 4\n 1 -2 =\u003e 1, 0, -1, -2", + "Description": "Seq creates a sequence of integers from args. It's named and used as GNU's seq.\n\nExamples:\n\n\t3 =\u003e 1, 2, 3\n\t1 2 4 =\u003e 1, 3\n\t-3 =\u003e -1, -2, -3\n\t1 4 =\u003e 1, 2, 3, 4\n\t1 -2 =\u003e 1, 0, -1, -2", "Args": [ "args" ], @@ -3425,9 +3425,9 @@ ] }, "Shuffle": { - "Description": "Shuffle returns the given rangeable list in a randomised order.", + "Description": "Shuffle returns list l in a randomised order.", "Args": [ - "seq" + "l" ], "Aliases": [ "shuffle" @@ -3450,9 +3450,9 @@ ] }, "Sort": { - "Description": "Sort returns a sorted sequence.", + "Description": "Sort returns a sorted copy of the list l.", "Args": [ - "seq", + "l", "args" ], "Aliases": [ @@ -3493,9 +3493,9 @@ ] }, "Uniq": { - "Description": "Uniq takes in a slice or array and returns a slice with subsequent\nduplicate elements removed.", + "Description": "Uniq takes returns a new list with all duplicate elements in the list l removed.\nduplicate elements removed.", "Args": [ - "seq" + "l" ], "Aliases": [ "uniq" @@ -3508,9 +3508,9 @@ ] }, "Where": { - "Description": "Where returns a filtered subset of a given data type.", + "Description": "Where returns a filtered subset of collection c.", "Args": [ - "seq", + "c", "key", "args" ], @@ -3522,9 +3522,9 @@ }, "crypto": { "FNV32a": { - "Description": "FNV32a hashes using fnv32a algorithm", + "Description": "FNV32a hashes v using fnv32a algorithm.", "Args": [ - "in" + "v" ], "Aliases": null, "Examples": [ @@ -3553,9 +3553,9 @@ ] }, "MD5": { - "Description": "MD5 hashes the given input and returns its MD5 checksum.", + "Description": "MD5 hashes the v and returns its MD5 checksum.", "Args": [ - "in" + "v" ], "Aliases": [ "md5" @@ -3572,9 +3572,9 @@ ] }, "SHA1": { - "Description": "SHA1 hashes the given input and returns its SHA1 checksum.", + "Description": "SHA1 hashes v and returns its SHA1 checksum.", "Args": [ - "in" + "v" ], "Aliases": [ "sha1" @@ -3587,9 +3587,9 @@ ] }, "SHA256": { - "Description": "SHA256 hashes the given input and returns its SHA256 checksum.", + "Description": "SHA256 hashes v and returns its SHA256 checksum.", "Args": [ - "in" + "v" ], "Aliases": [ "sha256" @@ -3604,7 +3604,7 @@ }, "data": { "GetCSV": { - "Description": "GetCSV expects a data separator and one or n-parts of a URL to a resource which\ncan either be a local or a remote one.\nThe data separator can be a comma, semi-colon, pipe, etc, but only one character.\nIf you provide multiple parts for the URL they will be joined together to the final URL.\nGetCSV returns nil or a slice slice to use in a short code.", + "Description": "GetCSV expects the separator sep and one or n-parts of a URL to a resource which\ncan either be a local or a remote one.\nThe data separator can be a comma, semi-colon, pipe, etc, but only one character.\nIf you provide multiple parts for the URL they will be joined together to the final URL.\nGetCSV returns nil or a slice slice to use in a short code.", "Args": [ "sep", "args" @@ -3615,7 +3615,7 @@ "Examples": [] }, "GetJSON": { - "Description": "GetJSON expects one or n-parts of a URL to a resource which can either be a local or a remote one.\nIf you provide multiple parts they will be joined together to the final URL.\nGetJSON returns nil or parsed JSON to use in a short code.", + "Description": "GetJSON expects one or n-parts of a URL in args to a resource which can either be a local or a remote one.\nIf you provide multiple parts they will be joined together to the final URL.\nGetJSON returns nil or parsed JSON to use in a short code.", "Args": [ "args" ], @@ -3627,7 +3627,7 @@ }, "debug": { "Dump": { - "Description": "Dump returns a object dump of val as a string.\nNote that not every value passed to Dump will print so nicely, but\nwe'll improve on that. We recommend using the \"go\" Chroma lexer to format the output\nnicely.\nAlso note that the output from Dump may change from Hugo version to the next,\nso don't depend on a specific output.", + "Description": "Dump returns a object dump of val as a string.\nNote that not every value passed to Dump will print so nicely, but\nwe'll improve on that.\n\nWe recommend using the \"go\" Chroma lexer to format the output\nnicely.\n\nAlso note that the output from Dump may change from Hugo version to the next,\nso don't depend on a specific output.", "Args": [ "val" ], @@ -3684,7 +3684,7 @@ ] }, "Jsonify": { - "Description": "Jsonify encodes a given object to JSON. To pretty print the JSON, pass a map\nor dictionary of options as the first argument. Supported options are\n\"prefix\" and \"indent\". Each JSON element in the output will begin on a new\nline beginning with prefix followed by one or more copies of indent according\nto the indentation nesting.", + "Description": "Jsonify encodes a given object to JSON. To pretty print the JSON, pass a map\nor dictionary of options as the first value in args. Supported options are\n\"prefix\" and \"indent\". Each JSON element in the output will begin on a new\nline beginning with prefix followed by one or more copies of indent according\nto the indentation nesting.", "Args": [ "args" ], @@ -3721,7 +3721,7 @@ ] }, "Erroridf": { - "Description": "Erroridf formats args according to a format specifier and logs an ERROR and\nan information text that the error with the given ID can be suppressed in config.\nIt returns an empty string.", + "Description": "Erroridf formats args according to a format specifier and logs an ERROR and\nan information text that the error with the given id can be suppressed in config.\nIt returns an empty string.", "Args": [ "id", "format", @@ -3738,7 +3738,7 @@ ] }, "Print": { - "Description": "Print returns a string representation args.", + "Description": "Print returns a string representation of args.", "Args": [ "args" ], @@ -3753,7 +3753,7 @@ ] }, "Printf": { - "Description": "Printf returns a formatted string representation of args.", + "Description": "Printf returns string representation of args formatted with the layouut in format.", "Args": [ "format", "args" @@ -3948,9 +3948,9 @@ }, "inflect": { "Humanize": { - "Description": "Humanize returns the humanized form of a single parameter.\n\nIf the parameter is either an integer or a string containing an integer\nvalue, the behavior is to add the appropriate ordinal.\n\n Example: \"my-first-post\" -\u003e \"My first post\"\n Example: \"103\" -\u003e \"103rd\"\n Example: 52 -\u003e \"52nd\"", + "Description": "Humanize returns the humanized form of v.\n\nIf v is either an integer or a string containing an integer\nvalue, the behavior is to add the appropriate ordinal.", "Args": [ - "in" + "v" ], "Aliases": [ "humanize" @@ -3975,9 +3975,9 @@ ] }, "Pluralize": { - "Description": "Pluralize returns the plural form of a single word.", + "Description": "Pluralize returns the plural form of the single word in v.", "Args": [ - "in" + "v" ], "Aliases": [ "pluralize" @@ -3990,9 +3990,9 @@ ] }, "Singularize": { - "Description": "Singularize returns the singular form of a single word.", + "Description": "Singularize returns the singular form of a single word in v.", "Args": [ - "in" + "v" ], "Aliases": [ "singularize" |