From 853a0e0677a2f169d9d6636f1435456dabdae7d1 Mon Sep 17 00:00:00 2001 From: Vicken Simonian Date: Thu, 5 Sep 2019 10:08:34 -0700 Subject: [PATCH] docs: Minor spelling and typo fixes --- lang/funcs/collection.go | 4 +- lang/funcs/string.go | 2 +- .../docs/commands/providers/schema.html.md | 42 +++++++++---------- .../docs/configuration-0-11/terraform.html.md | 2 +- .../functions/setintersection.html.md | 2 +- .../functions/setproduct.html.md | 2 +- .../configuration/functions/setunion.html.md | 2 +- .../configuration/functions/timestamp.html.md | 2 +- .../configuration/functions/uuidv5.html.md | 2 +- 9 files changed, 30 insertions(+), 30 deletions(-) diff --git a/lang/funcs/collection.go b/lang/funcs/collection.go index e6898457b..50b52b3cf 100644 --- a/lang/funcs/collection.go +++ b/lang/funcs/collection.go @@ -940,7 +940,7 @@ var ReverseFunc = function.New(&function.Spec{ }, }) -// SetProductFunc calculates the cartesian product of two or more sets or +// SetProductFunc calculates the Cartesian product of two or more sets or // sequences. If the arguments are all lists then the result is a list of tuples, // preserving the ordering of all of the input lists. Otherwise the result is a // set of tuples. @@ -1491,7 +1491,7 @@ func Reverse(list cty.Value) (cty.Value, error) { return ReverseFunc.Call([]cty.Value{list}) } -// SetProduct computes the cartesian product of sets or sequences. +// SetProduct computes the Cartesian product of sets or sequences. func SetProduct(sets ...cty.Value) (cty.Value, error) { return SetProductFunc.Call(sets) } diff --git a/lang/funcs/string.go b/lang/funcs/string.go index c9ddf19e3..1505600a6 100644 --- a/lang/funcs/string.go +++ b/lang/funcs/string.go @@ -71,7 +71,7 @@ var SortFunc = function.New(&function.Spec{ if !listVal.IsWhollyKnown() { // If some of the element values aren't known yet then we - // can't yet preduct the order of the result. + // can't yet predict the order of the result. return cty.UnknownVal(retType), nil } if listVal.LengthInt() == 0 { // Easy path diff --git a/website/docs/commands/providers/schema.html.md b/website/docs/commands/providers/schema.html.md index 14bbd5465..717d463eb 100644 --- a/website/docs/commands/providers/schema.html.md +++ b/website/docs/commands/providers/schema.html.md @@ -19,9 +19,9 @@ Usage: `terraform providers schema [options]` The list of available flags are: -* `-json` - Displays the schemas in a machine-readble, JSON format. +* `-json` - Displays the schemas in a machine-readable, JSON format. -Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. +Please note that, at this time, the `-json` flag is a _required_ option. In future releases, this command will be extended to allow for additional options. -> **Note:** The output includes a `format_version` key, which currently has major version zero to indicate that the format is experimental and subject to change. A future version will assign a non-zero major version and make stronger promises about compatibility. We do not anticipate any significant breaking changes to the format before its first major version, however. @@ -37,20 +37,20 @@ The JSON output format consists of the following objects and sub-objects: - [Schema Representation](#schema-representation) - a sub-object of providers, resources, and data sources that describes their schema - [Block Representation](#block-representation) - a sub-object of schemas that describes attributes and nested blocks -## Providers Schema Representation +## Providers Schema Representation ```javascript { "format_version": "0.1", - - // "provider_schemas" describes the provider schemas for all - // providers throughout the configuration tree. + + // "provider_schemas" describes the provider schemas for all + // providers throughout the configuration tree. "provider_schemas": { // keys in this map are the provider type, such as "random" "example_provider_name": { // "provider" is the schema for the provider configuration "provider": , - + // "resource_schemas" map the resource type name to the resource's schema "resource_schemas": { "example_resource_name": @@ -85,7 +85,7 @@ A block representation contains "attributes" and "block_types" (which represent ```javascript { - // "attributes" describes any attributes that appear directly inside the + // "attributes" describes any attributes that appear directly inside the // block. Keys in this map are the attribute names. "attributes": { "example_attribute_name": { @@ -93,20 +93,20 @@ A block representation contains "attributes" and "block_types" (which represent // that the attribute's value must conform to. "type": "string", - // "description" is an English-language description of + // "description" is an English-language description of // the purpose and usage of the attribute. "description": "string", - // "required", if set to true, specifies that an + // "required", if set to true, specifies that an // omitted or null value is not permitted. "required": bool, - // "optional", if set to true, specifies that an - // omitted or null value is permitted. + // "optional", if set to true, specifies that an + // omitted or null value is permitted. "optional": bool, - // "computed", if set to true, indicates that the - // value comes from the provider rather than the + // "computed", if set to true, indicates that the + // value comes from the provider rather than the // configuration. "computed": bool, @@ -118,9 +118,9 @@ A block representation contains "attributes" and "block_types" (which represent // "block_types" describes any nested blocks that appear directly // inside the block. // Keys in this map are the names of the block_type. - "block_types": { - "example_block_name": { - // "nesting_mode" describes the nesting mode for the + "block_types": { + "example_block_name": { + // "nesting_mode" describes the nesting mode for the // child block, and can be one of the following: // single // list @@ -129,10 +129,10 @@ A block representation contains "attributes" and "block_types" (which represent "nesting_mode": "list", "block": , - // "min_items" and "max_items" set lower and upper - // limits on the number of child blocks allowed for - // the list and set modes. These are - // omitted for other modes. + // "min_items" and "max_items" set lower and upper + // limits on the number of child blocks allowed for + // the list and set modes. These are + // omitted for other modes. "min_items": 1, "max_items": 3 } diff --git a/website/docs/configuration-0-11/terraform.html.md b/website/docs/configuration-0-11/terraform.html.md index b57ccc77e..ff75cbced 100644 --- a/website/docs/configuration-0-11/terraform.html.md +++ b/website/docs/configuration-0-11/terraform.html.md @@ -56,7 +56,7 @@ constraints specified, Terraform will show an error and exit. When [modules](./modules.html) are used, all Terraform version requirements specified by the complete module tree must be -satisified. This means that the `required_version` setting can be used +satisfied. This means that the `required_version` setting can be used by a module to require that all consumers of a module also use a specific version. diff --git a/website/docs/configuration/functions/setintersection.html.md b/website/docs/configuration/functions/setintersection.html.md index 1635e82aa..ef48dc036 100644 --- a/website/docs/configuration/functions/setintersection.html.md +++ b/website/docs/configuration/functions/setintersection.html.md @@ -38,7 +38,7 @@ the ordering of the given elements is not preserved. * [`contains`](./contains.html) tests whether a given list or set contains a given element value. -* [`setproduct`](./setproduct.html) computes the _cartesian product_ of multiple +* [`setproduct`](./setproduct.html) computes the _Cartesian product_ of multiple sets. * [`setunion`](./setunion.html) computes the _union_ of multiple sets. diff --git a/website/docs/configuration/functions/setproduct.html.md b/website/docs/configuration/functions/setproduct.html.md index 96eb55065..dd5fdd22d 100644 --- a/website/docs/configuration/functions/setproduct.html.md +++ b/website/docs/configuration/functions/setproduct.html.md @@ -15,7 +15,7 @@ earlier, see The `setproduct` function finds all of the possible combinations of elements from all of the given sets by computing the -[cartesian product](https://en.wikipedia.org/wiki/Cartesian_product). +[Cartesian product](https://en.wikipedia.org/wiki/Cartesian_product). ```hcl setproduct(sets...) diff --git a/website/docs/configuration/functions/setunion.html.md b/website/docs/configuration/functions/setunion.html.md index 05ad07490..77e3d92d9 100644 --- a/website/docs/configuration/functions/setunion.html.md +++ b/website/docs/configuration/functions/setunion.html.md @@ -43,5 +43,5 @@ the ordering of the given elements is not preserved. a given element value. * [`setintersection`](./setintersection.html) computes the _intersection_ of multiple sets. -* [`setproduct`](./setproduct.html) computes the _cartesian product_ of multiple +* [`setproduct`](./setproduct.html) computes the _Cartesian product_ of multiple sets. diff --git a/website/docs/configuration/functions/timestamp.html.md b/website/docs/configuration/functions/timestamp.html.md index 4f0684c0a..52d752f07 100644 --- a/website/docs/configuration/functions/timestamp.html.md +++ b/website/docs/configuration/functions/timestamp.html.md @@ -28,7 +28,7 @@ but in rare cases it can be used in conjunction with to take the timestamp only on initial creation of the resource. Due to the constantly changing return value, the result of this function cannot -be preducted during Terraform's planning phase, and so the timestamp will be +be predicted during Terraform's planning phase, and so the timestamp will be taken only once the plan is being applied. ## Examples diff --git a/website/docs/configuration/functions/uuidv5.html.md b/website/docs/configuration/functions/uuidv5.html.md index 4c1028745..d48831821 100644 --- a/website/docs/configuration/functions/uuidv5.html.md +++ b/website/docs/configuration/functions/uuidv5.html.md @@ -76,7 +76,7 @@ ede1a974-df7e-5f17-84b9-76208818b2c8 ``` When using raw UUID namespaces, consider including a comment alongside the -expression that indicates which namespace this repressents in a +expression that indicates which namespace this represents in a human-significant manner, such as by reference to the standard that defined it.