summaryrefslogtreecommitdiff
path: root/docs
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
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')
-rw-r--r--docs/content/config.md2
-rw-r--r--docs/content/datasources.md2
-rw-r--r--docs/content/functions/conv.md12
-rw-r--r--docs/content/functions/data.md4
-rw-r--r--docs/content/functions/filepath.md2
-rw-r--r--docs/content/functions/math.md4
-rw-r--r--docs/content/functions/semver.md2
-rw-r--r--docs/content/functions/time.md2
-rw-r--r--docs/content/syntax.md2
-rw-r--r--docs/content/usage.md2
10 files changed, 17 insertions, 17 deletions
diff --git a/docs/content/config.md b/docs/content/config.md
index 00e2edba..a70d1dde 100644
--- a/docs/content/config.md
+++ b/docs/content/config.md
@@ -159,7 +159,7 @@ See [`--exec-pipe`](../usage/#--exec-pipe).
Use the rendered output as the [`postExec`](#postexec) command's standard input.
-Must be used in conjuction with [`postExec`](#postexec), and will override
+Must be used in conjunction with [`postExec`](#postexec), and will override
any [`outputFiles`](#outputfiles) settings.
## `experimental`
diff --git a/docs/content/datasources.md b/docs/content/datasources.md
index 9d23740c..03d54a2f 100644
--- a/docs/content/datasources.md
+++ b/docs/content/datasources.md
@@ -136,7 +136,7 @@ bar
### The `.env` file format
-Many applications and frameworks support the use of a ".env" file for providing environment variables. It can also be considerd a simple key/value file format, and as such can be used as a datasource in gomplate.
+Many applications and frameworks support the use of a ".env" file for providing environment variables. It can also be considered a simple key/value file format, and as such can be used as a datasource in gomplate.
To [override](#overriding-mime-types), use the unregistered `application/x-env` MIME type.
diff --git a/docs/content/functions/conv.md b/docs/content/functions/conv.md
index 21941477..bf4ccc71 100644
--- a/docs/content/functions/conv.md
+++ b/docs/content/functions/conv.md
@@ -454,7 +454,7 @@ Converts the input to an `int64` (64-bit signed integer).
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.
@@ -493,7 +493,7 @@ on platform). This is similar to [`conv.ToInt64`](#convtoint64) on 64-bit
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
@@ -534,7 +534,7 @@ $ gomplate -i '{{conv.ToInt true }}'
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.
@@ -562,7 +562,7 @@ gomplate -i '{{ conv.ToInt64s true 0x42 "123,456.99" "1.2345e+3"}}'
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.
@@ -593,7 +593,7 @@ Converts the input to a `float64`.
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.
_Added in gomplate [v2.2.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.2.0)_
### Usage
@@ -621,7 +621,7 @@ $ gomplate -i '{{ conv.ToFloat64 "9,000.09"}}'
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.
diff --git a/docs/content/functions/data.md b/docs/content/functions/data.md
index 7a504be1..eaa99f45 100644
--- a/docs/content/functions/data.md
+++ b/docs/content/functions/data.md
@@ -210,7 +210,7 @@ $ gomplate -d person.json -f input.tmpl
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)
@@ -291,7 +291,7 @@ Hello world
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).
_Added in gomplate [v2.0.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.0.0)_
### Usage
diff --git a/docs/content/functions/filepath.md b/docs/content/functions/filepath.md
index 2f252638..e459f663 100644
--- a/docs/content/functions/filepath.md
+++ b/docs/content/functions/filepath.md
@@ -277,7 +277,7 @@ b/c
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.
diff --git a/docs/content/functions/math.md b/docs/content/functions/math.md
index 52e59406..ee006c7b 100644
--- a/docs/content/functions/math.md
+++ b/docs/content/functions/math.md
@@ -158,7 +158,7 @@ math.Floor num
| name | description |
|------|-------------|
-| `num` | _(required)_ The input number. Will be converted to a `float64`, or `0` if not convertable |
+| `num` | _(required)_ The input number. Will be converted to a `float64`, or `0` if not convertible |
### Examples
@@ -408,7 +408,7 @@ math.Round num
| name | description |
|------|-------------|
-| `num` | _(required)_ The input number. Will be converted to a `float64`, or `0` if not convertable |
+| `num` | _(required)_ The input number. Will be converted to a `float64`, or `0` if not convertible |
### Examples
diff --git a/docs/content/functions/semver.md b/docs/content/functions/semver.md
index b94488ff..03c97ea4 100644
--- a/docs/content/functions/semver.md
+++ b/docs/content/functions/semver.md
@@ -49,7 +49,7 @@ the pre release version is 1.1.1-beta.1
## `semver.CheckConstraint`_(unreleased)_
**Unreleased:** _This function is in development, and not yet available in released builds of gomplate._
-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
diff --git a/docs/content/functions/time.md b/docs/content/functions/time.md
index cb93aef7..e2939b53 100644
--- a/docs/content/functions/time.md
+++ b/docs/content/functions/time.md
@@ -187,7 +187,7 @@ $ gomplate -i '{{ (time.Now).Format time.Kitchen }}
## `time.ParseLocal`
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.
_Added in gomplate [v2.2.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.2.0)_
### Usage
diff --git a/docs/content/syntax.md b/docs/content/syntax.md
index 98eeaef2..5e5389e8 100644
--- a/docs/content/syntax.md
+++ b/docs/content/syntax.md
@@ -74,7 +74,7 @@ Hello, bar!
Hello, baz!
```
-### Suppressing trailling newlines
+### Suppressing trailing newlines
This code:
diff --git a/docs/content/usage.md b/docs/content/usage.md
index 3b8f4b28..dade86c6 100644
--- a/docs/content/usage.md
+++ b/docs/content/usage.md
@@ -64,7 +64,7 @@ gomplate --input-dir=templates --output-dir=config --datasource config=config.ya
### `--output-map`
-Sometimes a 1-to-1 mapping betwen input filenames and output filenames is not desirable. For these cases, you can supply a template string as the argument to `--output-map`. The template string is interpreted as a regular gomplate template, and all datasources and external nested templates are available to the output map template.
+Sometimes a 1-to-1 mapping between input filenames and output filenames is not desirable. For these cases, you can supply a template string as the argument to `--output-map`. The template string is interpreted as a regular gomplate template, and all datasources and external nested templates are available to the output map template.
A new [context][] is provided, with the input filename is available at `.in`, and the original context is available at `.ctx`. For convenience, any context keys not conflicting with `in` or `ctx` are also copied.