summaryrefslogtreecommitdiff
path: root/docs-src/content
diff options
context:
space:
mode:
authorKian-Meng Ang <kianmeng.ang@gmail.com>2025-03-10 09:01:38 +0800
committerGitHub <noreply@github.com>2025-03-09 21:01:38 -0400
commit51be3c341c2f1a2295d0ed22615d80581e86742c (patch)
treee0b6f73756137c00fb55960c378e9d607add64b0 /docs-src/content
parenta378c6d544ad43143939e2b247751279abec8019 (diff)
docs(fix): fix typos (#2344)
* docs(fix): fix typos Found via `codespell -L fom,fo,wil,nd,wit` and `typos --hidden --format brief` * docs(fix): regenerate docs Signed-off-by: Dave Henderson <dhenderson@gmail.com> --------- Signed-off-by: Dave Henderson <dhenderson@gmail.com> Co-authored-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs-src/content')
-rw-r--r--docs-src/content/functions/conv.yml12
-rw-r--r--docs-src/content/functions/data.yml4
-rw-r--r--docs-src/content/functions/filepath.yml2
-rw-r--r--docs-src/content/functions/math.yml4
-rw-r--r--docs-src/content/functions/semver.yml2
-rw-r--r--docs-src/content/functions/time.yml2
6 files changed, 13 insertions, 13 deletions
diff --git a/docs-src/content/functions/conv.yml b/docs-src/content/functions/conv.yml
index 76337b5e..98f4ad71 100644
--- a/docs-src/content/functions/conv.yml
+++ b/docs-src/content/functions/conv.yml
@@ -302,7 +302,7 @@ funcs:
This function attempts to convert most types of input (strings, numbers,
and booleans).
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
Floating-point numbers (with decimal points) are truncated.
arguments:
@@ -327,7 +327,7 @@ funcs:
platforms, but is useful when input to another function must be provided
as an `int`.
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
On 32-bit systems, given a number that is too large to fit in an `int`,
the result is `-1`. This is done to protect against
@@ -354,7 +354,7 @@ funcs:
description: |
Converts the inputs to an array of `int64`s.
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
This delegates to [`conv.ToInt64`](#convtoint64) for each input argument.
arguments:
@@ -370,7 +370,7 @@ funcs:
description: |
Converts the inputs to an array of `int`s.
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
This delegates to [`conv.ToInt`](#convtoint) for each input argument.
arguments:
@@ -389,7 +389,7 @@ funcs:
This function attempts to convert most types of input (strings, numbers,
and booleans).
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
arguments:
- name: in
required: true
@@ -405,7 +405,7 @@ funcs:
description: |
Converts the inputs to an array of `float64`s.
- Unconvertable inputs will result in errors.
+ Unconvertible inputs will result in errors.
This delegates to [`conv.ToFloat64`](#convtofloat64) for each input argument.
arguments:
diff --git a/docs-src/content/functions/data.yml b/docs-src/content/functions/data.yml
index eaa3b0ce..9691854f 100644
--- a/docs-src/content/functions/data.yml
+++ b/docs-src/content/functions/data.yml
@@ -151,7 +151,7 @@ funcs:
Converts a JSON string into an object. Works for JSON Objects, but will
also parse JSON Arrays. Will not parse other valid JSON types.
- For more explict JSON Array support, see [`data.JSONArray`](#datajsonarray).
+ For more explicit JSON Array support, see [`data.JSONArray`](#datajsonarray).
#### Encrypted JSON support (EJSON)
@@ -206,7 +206,7 @@ funcs:
Converts a YAML string into an object. Works for YAML Objects but will
also parse YAML Arrays. This can be used to access properties of YAML objects.
- For more explict YAML Array support, see [`data.JSONArray`](#datayamlarray).
+ For more explicit YAML Array support, see [`data.JSONArray`](#datayamlarray).
pipeline: true
arguments:
- name: in
diff --git a/docs-src/content/functions/filepath.yml b/docs-src/content/functions/filepath.yml
index 69b65c0c..6d73da8e 100644
--- a/docs-src/content/functions/filepath.yml
+++ b/docs-src/content/functions/filepath.yml
@@ -157,7 +157,7 @@ funcs:
description: |
Splits path immediately following the final path separator, separating it into a directory and file name component.
- The function returns an array with two values, the first being the diretory, and the second the file.
+ The function returns an array with two values, the first being the directory, and the second the file.
A wrapper for Go's [`filepath.Split`](https://pkg.go.dev/path/filepath/#Split) function.
pipeline: true
diff --git a/docs-src/content/functions/math.yml b/docs-src/content/functions/math.yml
index 53f14103..fef19393 100644
--- a/docs-src/content/functions/math.yml
+++ b/docs-src/content/functions/math.yml
@@ -95,7 +95,7 @@ funcs:
arguments:
- name: num
required: true
- description: The input number. Will be converted to a `float64`, or `0` if not convertable
+ description: The input number. Will be converted to a `float64`, or `0` if not convertible
examples:
- |
$ gomplate -i '{{ range (coll.Slice 5.1 42 "3.14" "0xFF" "NaN" "Inf" "-0") }}floor {{ printf "%#v" . }} = {{ math.Floor . }}{{"\n"}}{{ end }}'
@@ -236,7 +236,7 @@ funcs:
arguments:
- name: num
required: true
- description: The input number. Will be converted to a `float64`, or `0` if not convertable
+ description: The input number. Will be converted to a `float64`, or `0` if not convertible
examples:
- |
$ gomplate -i '{{ range (coll.Slice -6.5 5.1 42.9 "3.5" 6.5) }}round {{ printf "%#v" . }} = {{ math.Round . }}{{"\n"}}{{ end }}'
diff --git a/docs-src/content/functions/semver.yml b/docs-src/content/functions/semver.yml
index 08710afa..1eb49e91 100644
--- a/docs-src/content/functions/semver.yml
+++ b/docs-src/content/functions/semver.yml
@@ -26,7 +26,7 @@ funcs:
the pre release version is 1.1.1-beta.1
- name: semver.CheckConstraint
description: |
- Test whether the input version matchs the constraint.
+ Test whether the input version matches the constraint.
Ref: https://github.com/Masterminds/semver#checking-version-constraints
pipeline: true
diff --git a/docs-src/content/functions/time.yml b/docs-src/content/functions/time.yml
index ddef213e..378e3003 100644
--- a/docs-src/content/functions/time.yml
+++ b/docs-src/content/functions/time.yml
@@ -153,7 +153,7 @@ funcs:
released: v2.2.0
description: |
Same as [`time.Parse`](#timeparse), except that in the absence of a time zone
- indicator, the timestamp wil be parsed in the local timezone.
+ indicator, the timestamp will be parsed in the local timezone.
pipeline: true
arguments:
- name: layout