🧹 Capitalize "See below for nested schema" #442
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
misterpantz
reviewed
Jan 31, 2025
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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)) |
There was a problem hiding this comment.
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
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just a small nitpick on capitalization.