Skip to content

Commit 12b88f4

Browse files
committed
docs: spelling corrections
1 parent 7bffe4d commit 12b88f4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

cmd/docs/templates/_schema.tmpl

+11-11
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
| `apiVersion` | `string` | `v1` | Version of the recipe metadata API schema. Currently should have value "v1". |
99
| `name` | `string` | | Name of the recipe. |
1010
| `version` | `string` | | Version of the recipe. Must be valid [semver](https://semver.org/). |
11-
| `description` | `string` | | Description of what the recipe does |
11+
| `description` | `string` | | Description of what the recipe does. |
1212
| `source` | `string` | | URL to source code for this recipe. |
1313
| `templateExtension` | `string` | | File extension of files in "templates" directory which should be templated. Files not matched by this extension will be copied as-is. If left empty (the default), all files will be templated. |
14-
| `initHelp` | `string` | | A message which will be showed to an user after a succesful recipe execution. Can be used to guide the user what should be done next in the project directory. Supports templating |
14+
| `initHelp` | `string` | | A message which will be shown to an user after a successful recipe execution. Can be used to guide the user on what should be done next in the project directory. Supports templating. |
1515
| `ignorePatterns` | `[]string` | | Glob patterns for ignoring generated files from future recipe upgrades. Ignored files will not be regenerated even if their templates change in future versions of the recipe. |
1616
| `vars` | [`[]Variable`](#variable) | | An array of variables which can be used in templates. The user will be prompted to provide the value for the variable if not set with `--set` flag. |
1717

@@ -21,16 +21,16 @@
2121

2222
| Attribute | Type | Default | Description |
2323
| --- | --- | --- | --- |
24-
| `name` | `string` | | The name of the variable. It is also used as unique identifier, so two variables can not have the same name. |
24+
| `name` | `string` | | The name of the variable. It is also used as an unique identifier, so two variables cannot have the same name. |
2525
| `description` | `string` | | Description of the variable. Will be shown to the user when "show help" is activated. |
2626
| `default` | `string` | | Default value of the variable. |
27-
| `confirm` | `bool` | `false` | If set to true, the prompt will be yes/no question, and the value type will be boolean. |
27+
| `confirm` | `bool` | `false` | If set to true, the prompt will be a yes/no question, and the value type will be boolean. |
2828
| `optional` | `bool` | `false` | If set to true, the variable can be left empty. |
2929
| `options` | `[]string` | | The user selects the value from a list of options. |
3030
| `multi` | `bool` | `false` | If set to true, the user can select multiple options defined by the `options` property. |
3131
| `validators` | [`[]Validator`](#validator) | | Validators for the variable. |
3232
| `if` | `string` | | Makes the variable conditional based on the result of the expression. The result of the evaluation needs to be a boolean value. Uses https://github.com/expr-lang/expr. |
33-
| `columns` | `[]string` | | Set the variable as a table type with columns defined by this property. |
33+
| `columns` | `[]string` | | Set the variable as a table type with columns defined by this property. |
3434

3535
### Validator
3636

@@ -50,8 +50,8 @@
5050
| Attribute | Type | Default | Description |
5151
| --- | --- | --- | --- |
5252
| `values` | `map[string]any` | | Values to use to render the recipe templates. Map key is the name of the variable and value is the variable value. |
53-
| `expectedInitHelp` | `string` | | Expected initHelp of the recipe when rendered with the values specified in the test |
54-
| `ignoreExtraFiles` | `bool` | | If true, test will pass even though templates generated more files than the test specifies. This is useful when creating specific test cases for large recipes. |
53+
| `expectedInitHelp` | `string` | | Expected initHelp of the recipe when rendered with the values specified in the test. |
54+
| `ignoreExtraFiles` | `bool` | | If true, the test will pass even though templates generated more files than the test specifies. This is useful when creating specific test cases for large recipes. |
5555

5656
## Sauce schema (`sauces.yml`)
5757

@@ -61,9 +61,9 @@
6161
| --- | --- | --- | --- |
6262
| `apiVersion` | `string` | `v1` | Version of the sauce API schema. Currently should have value "v1". |
6363
| `recipe` | [`Recipe`](#recipe-schema-recipeyml) | | The recipe which was used to render the sauce. |
64-
| `values` | `map[string]any` | | Values which was used to execute the recipe. |
65-
| `files` | `map[string]File` | | Files genereated from the recipe |
66-
| `id` | `string` | | Random unique ID whose value is determined on first render and stays the same on subsequent re-renders (upgrades) of the sauce. Can be used for example as a seed for template random functions to provide same result on each template. |
64+
| `values` | `map[string]any` | | Values which were used to execute the recipe. |
65+
| `files` | `map[string]File` | | Files generated by the recipe. |
66+
| `id` | `string` | | Random unique ID whose value is determined on first render and stays the same on subsequent re-renders (upgrades) of the sauce. Can be used for example as a seed for template random functions to provide the same result on each template. |
6767
| `from` | `string` | | Defines the repository where updates should be checked for the recipe. |
6868
| `subpath` | `string` | | Subpath which is used as a path prefix when saving and loading the sauce files. This is commonly used in monorepos. |
6969

@@ -85,6 +85,6 @@
8585
| `name` | `string` | | The name of the recipe. |
8686
| `version` | `string` | | The version of the recipe. |
8787
| `repository` | `string` | | The repository where the recipe is located. Can be a local path or remote URL. |
88-
| `values` | `map[string]any` | | Values which was used to execute the recipe. |
88+
| `values` | `map[string]any` | | Values which were used to execute the recipe. |
8989

9090
{{- end }}

0 commit comments

Comments
 (0)