docs: Minor spelling and typo fixes

This commit is contained in:
Vicken Simonian 2019-09-05 10:08:34 -07:00
parent 3b0de1aa88
commit 853a0e0677
9 changed files with 30 additions and 30 deletions

View File

@ -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, // 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 // preserving the ordering of all of the input lists. Otherwise the result is a
// set of tuples. // set of tuples.
@ -1491,7 +1491,7 @@ func Reverse(list cty.Value) (cty.Value, error) {
return ReverseFunc.Call([]cty.Value{list}) 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) { func SetProduct(sets ...cty.Value) (cty.Value, error) {
return SetProductFunc.Call(sets) return SetProductFunc.Call(sets)
} }

View File

@ -71,7 +71,7 @@ var SortFunc = function.New(&function.Spec{
if !listVal.IsWhollyKnown() { if !listVal.IsWhollyKnown() {
// If some of the element values aren't known yet then we // 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 return cty.UnknownVal(retType), nil
} }
if listVal.LengthInt() == 0 { // Easy path if listVal.LengthInt() == 0 { // Easy path

View File

@ -19,9 +19,9 @@ Usage: `terraform providers schema [options]`
The list of available flags are: 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. -> **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 - [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 - [Block Representation](#block-representation) - a sub-object of schemas that describes attributes and nested blocks
## Providers Schema Representation ## Providers Schema Representation
```javascript ```javascript
{ {
"format_version": "0.1", "format_version": "0.1",
// "provider_schemas" describes the provider schemas for all // "provider_schemas" describes the provider schemas for all
// providers throughout the configuration tree. // providers throughout the configuration tree.
"provider_schemas": { "provider_schemas": {
// keys in this map are the provider type, such as "random" // keys in this map are the provider type, such as "random"
"example_provider_name": { "example_provider_name": {
// "provider" is the schema for the provider configuration // "provider" is the schema for the provider configuration
"provider": <schema-representation>, "provider": <schema-representation>,
// "resource_schemas" map the resource type name to the resource's schema // "resource_schemas" map the resource type name to the resource's schema
"resource_schemas": { "resource_schemas": {
"example_resource_name": <schema-representation> "example_resource_name": <schema-representation>
@ -85,7 +85,7 @@ A block representation contains "attributes" and "block_types" (which represent
```javascript ```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. // block. Keys in this map are the attribute names.
"attributes": { "attributes": {
"example_attribute_name": { "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. // that the attribute's value must conform to.
"type": "string", "type": "string",
// "description" is an English-language description of // "description" is an English-language description of
// the purpose and usage of the attribute. // the purpose and usage of the attribute.
"description": "string", "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. // omitted or null value is not permitted.
"required": bool, "required": bool,
// "optional", if set to true, specifies that an // "optional", if set to true, specifies that an
// omitted or null value is permitted. // omitted or null value is permitted.
"optional": bool, "optional": bool,
// "computed", if set to true, indicates that the // "computed", if set to true, indicates that the
// value comes from the provider rather than the // value comes from the provider rather than the
// configuration. // configuration.
"computed": bool, "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 // "block_types" describes any nested blocks that appear directly
// inside the block. // inside the block.
// Keys in this map are the names of the block_type. // Keys in this map are the names of the block_type.
"block_types": { "block_types": {
"example_block_name": { "example_block_name": {
// "nesting_mode" describes the nesting mode for the // "nesting_mode" describes the nesting mode for the
// child block, and can be one of the following: // child block, and can be one of the following:
// single // single
// list // list
@ -129,10 +129,10 @@ A block representation contains "attributes" and "block_types" (which represent
"nesting_mode": "list", "nesting_mode": "list",
"block": <block-representation>, "block": <block-representation>,
// "min_items" and "max_items" set lower and upper // "min_items" and "max_items" set lower and upper
// limits on the number of child blocks allowed for // limits on the number of child blocks allowed for
// the list and set modes. These are // the list and set modes. These are
// omitted for other modes. // omitted for other modes.
"min_items": 1, "min_items": 1,
"max_items": 3 "max_items": 3
} }

View File

@ -56,7 +56,7 @@ constraints specified, Terraform will show an error and exit.
When [modules](./modules.html) are used, all Terraform When [modules](./modules.html) are used, all Terraform
version requirements specified by the complete module tree must be 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 by a module to require that all consumers of a module also use a specific
version. version.

View File

@ -38,7 +38,7 @@ the ordering of the given elements is not preserved.
* [`contains`](./contains.html) tests whether a given list or set contains * [`contains`](./contains.html) tests whether a given list or set contains
a given element value. a given element value.
* [`setproduct`](./setproduct.html) computes the _cartesian product_ of multiple * [`setproduct`](./setproduct.html) computes the _Cartesian product_ of multiple
sets. sets.
* [`setunion`](./setunion.html) computes the _union_ of * [`setunion`](./setunion.html) computes the _union_ of
multiple sets. multiple sets.

View File

@ -15,7 +15,7 @@ earlier, see
The `setproduct` function finds all of the possible combinations of elements The `setproduct` function finds all of the possible combinations of elements
from all of the given sets by computing the 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 ```hcl
setproduct(sets...) setproduct(sets...)

View File

@ -43,5 +43,5 @@ the ordering of the given elements is not preserved.
a given element value. a given element value.
* [`setintersection`](./setintersection.html) computes the _intersection_ of * [`setintersection`](./setintersection.html) computes the _intersection_ of
multiple sets. multiple sets.
* [`setproduct`](./setproduct.html) computes the _cartesian product_ of multiple * [`setproduct`](./setproduct.html) computes the _Cartesian product_ of multiple
sets. sets.

View File

@ -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. to take the timestamp only on initial creation of the resource.
Due to the constantly changing return value, the result of this function cannot 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. taken only once the plan is being applied.
## Examples ## Examples

View File

@ -76,7 +76,7 @@ ede1a974-df7e-5f17-84b9-76208818b2c8
``` ```
When using raw UUID namespaces, consider including a comment alongside the 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 human-significant manner, such as by reference to the standard that
defined it. defined it.