Skip to content

🧹 Capitalize "See below for nested schema" - #442

Open
afiune wants to merge 1 commit into
hashicorp:mainfrom
afiune:afiune/see-below-for-nested-schema
Open

afiune wants to merge 1 commit into
hashicorp:mainfrom
afiune:afiune/see-below-for-nested-schema

Conversation

@afiune

@afiune afiune commented Jan 30, 2025

Copy link
Copy Markdown

Just a small nitpick on capitalization.

@afiune
afiune requested a review from a team as a code owner January 30, 2025 21:21
@hashicorp-cla

hashicorp-cla commented Jan 30, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@misterpantz misterpantz left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for this, @afiune!

Because "See below for nested schema" is a full, imperative sentence, not only should it begin with a capital S but it also should end in a period. I've added suggestions for those.

- `list_attribute` (List of String) example list attribute
- `list_nested_block` (Block List) example list nested block (see [below for nested schema](#nestedblock--list_nested_block))
- `list_nested_block_sensitive_nested_attribute` (Block List) (see [below for nested schema](#nestedblock--list_nested_block_sensitive_nested_attribute))
- `list_nested_block` (Block List) example list nested block (See [below for nested schema](#nestedblock--list_nested_block))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `list_nested_block` (Block List) example list nested block (See [below for nested schema](#nestedblock--list_nested_block))
- `list_nested_block` (Block List) example list nested block (See [below for nested schema](#nestedblock--list_nested_block).)

- `list_nested_block` (Block List) example list nested block (see [below for nested schema](#nestedblock--list_nested_block))
- `list_nested_block_sensitive_nested_attribute` (Block List) (see [below for nested schema](#nestedblock--list_nested_block_sensitive_nested_attribute))
- `list_nested_block` (Block List) example list nested block (See [below for nested schema](#nestedblock--list_nested_block))
- `list_nested_block_sensitive_nested_attribute` (Block List) (See [below for nested schema](#nestedblock--list_nested_block_sensitive_nested_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `list_nested_block_sensitive_nested_attribute` (Block List) (See [below for nested schema](#nestedblock--list_nested_block_sensitive_nested_attribute))
- `list_nested_block_sensitive_nested_attribute` (Block List) (See [below for nested schema](#nestedblock--list_nested_block_sensitive_nested_attribute).)

- `number_attribute` (Number) example number attribute
- `object_attribute` (Object) example object attribute (see [below for nested schema](#nestedatt--object_attribute))
- `object_attribute_with_nested_object_attribute` (Object) example object attribute with nested object attribute (see [below for nested schema](#nestedatt--object_attribute_with_nested_object_attribute))
- `object_attribute` (Object) example object attribute (See [below for nested schema](#nestedatt--object_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `object_attribute` (Object) example object attribute (See [below for nested schema](#nestedatt--object_attribute))
- `object_attribute` (Object) example object attribute (See [below for nested schema](#nestedatt--object_attribute).)

- `object_attribute` (Object) example object attribute (see [below for nested schema](#nestedatt--object_attribute))
- `object_attribute_with_nested_object_attribute` (Object) example object attribute with nested object attribute (see [below for nested schema](#nestedatt--object_attribute_with_nested_object_attribute))
- `object_attribute` (Object) example object attribute (See [below for nested schema](#nestedatt--object_attribute))
- `object_attribute_with_nested_object_attribute` (Object) example object attribute with nested object attribute (See [below for nested schema](#nestedatt--object_attribute_with_nested_object_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `object_attribute_with_nested_object_attribute` (Object) example object attribute with nested object attribute (See [below for nested schema](#nestedatt--object_attribute_with_nested_object_attribute))
- `object_attribute_with_nested_object_attribute` (Object) example object attribute with nested object attribute (See [below for nested schema](#nestedatt--object_attribute_with_nested_object_attribute).)

- `sensitive_map_attribute` (Map of String, Sensitive) example sensitive map attribute
- `sensitive_number_attribute` (Number, Sensitive) example sensitive number attribute
- `sensitive_object_attribute` (Object, Sensitive) example sensitive object attribute (see [below for nested schema](#nestedatt--sensitive_object_attribute))
- `sensitive_object_attribute` (Object, Sensitive) example sensitive object attribute (See [below for nested schema](#nestedatt--sensitive_object_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `sensitive_object_attribute` (Object, Sensitive) example sensitive object attribute (See [below for nested schema](#nestedatt--sensitive_object_attribute))
- `sensitive_object_attribute` (Object, Sensitive) example sensitive object attribute (See [below for nested schema](#nestedatt--sensitive_object_attribute).)

- `single_nested_block` (Block, Optional) example single nested block (see [below for nested schema](#nestedblock--single_nested_block))
- `single_nested_block_sensitive_nested_attribute` (Block, Optional) example sensitive single nested block (see [below for nested schema](#nestedblock--single_nested_block_sensitive_nested_attribute))
- `set_nested_block` (Block Set) example set nested block (See [below for nested schema](#nestedblock--set_nested_block))
- `single_nested_block` (Block, Optional) example single nested block (See [below for nested schema](#nestedblock--single_nested_block))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `single_nested_block` (Block, Optional) example single nested block (See [below for nested schema](#nestedblock--single_nested_block))
- `single_nested_block` (Block, Optional) example single nested block (See [below for nested schema](#nestedblock--single_nested_block).)

- `single_nested_block_sensitive_nested_attribute` (Block, Optional) example sensitive single nested block (see [below for nested schema](#nestedblock--single_nested_block_sensitive_nested_attribute))
- `set_nested_block` (Block Set) example set nested block (See [below for nested schema](#nestedblock--set_nested_block))
- `single_nested_block` (Block, Optional) example single nested block (See [below for nested schema](#nestedblock--single_nested_block))
- `single_nested_block_sensitive_nested_attribute` (Block, Optional) example sensitive single nested block (See [below for nested schema](#nestedblock--single_nested_block_sensitive_nested_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `single_nested_block_sensitive_nested_attribute` (Block, Optional) example sensitive single nested block (See [below for nested schema](#nestedblock--single_nested_block_sensitive_nested_attribute))
- `single_nested_block_sensitive_nested_attribute` (Block, Optional) example sensitive single nested block (See [below for nested schema](#nestedblock--single_nested_block_sensitive_nested_attribute).)


- `id` (String) The ID of this resource.
- `set_nested_block_sensitive_nested_attribute` (Block Set) example sensitive set nested block (see [below for nested schema](#nestedblock--set_nested_block_sensitive_nested_attribute))
- `set_nested_block_sensitive_nested_attribute` (Block Set) example sensitive set nested block (See [below for nested schema](#nestedblock--set_nested_block_sensitive_nested_attribute))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `set_nested_block_sensitive_nested_attribute` (Block Set) example sensitive set nested block (See [below for nested schema](#nestedblock--set_nested_block_sensitive_nested_attribute))
- `set_nested_block_sensitive_nested_attribute` (Block Set) example sensitive set nested block (See [below for nested schema](#nestedblock--set_nested_block_sensitive_nested_attribute).)

- `list_nested_block_attribute` (String) example list nested block attribute
- `list_nested_block_attribute_with_default` (String) example list nested block attribute with default
- `nested_list_block` (Block List) (see [below for nested schema](#nestedblock--list_nested_block--nested_list_block))
- `nested_list_block` (Block List) (See [below for nested schema](#nestedblock--list_nested_block--nested_list_block))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `nested_list_block` (Block List) (See [below for nested schema](#nestedblock--list_nested_block--nested_list_block))
- `nested_list_block` (Block List) (See [below for nested schema](#nestedblock--list_nested_block--nested_list_block).)

Optional:

- `nested_object` (Object) (see [below for nested schema](#nestedobjatt--object_attribute_with_nested_object_attribute--nested_object))
- `nested_object` (Object) (See [below for nested schema](#nestedobjatt--object_attribute_with_nested_object_attribute--nested_object))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `nested_object` (Object) (See [below for nested schema](#nestedobjatt--object_attribute_with_nested_object_attribute--nested_object))
- `nested_object` (Object) (See [below for nested schema](#nestedobjatt--object_attribute_with_nested_object_attribute--nested_object).)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants