Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add naming recommendations #1892

Merged
merged 1 commit into from
Jul 31, 2023
Merged

Add naming recommendations #1892

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/source-2.0/guides/style-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,16 @@ Naming
Shape names
-----------

Shape names use a strict form of UpperCamelCase (e.g., "XmlRequest", "FooId").
* Shape names use a strict form of UpperCamelCase (e.g., "XmlRequest", "FooId").
* Numeric shapes should use descriptive names, including units of measurement
(e.g., prefer "SizeInMb" over "Size").
* Enums should use a singular noun (e.g., prefer "Suit" over "Suits").
mtdowling marked this conversation as resolved.
Show resolved Hide resolved
* Lists should use plural names (e.g., prefer "Users" over "UserList").
* Operations should follow the format of "VerbNoun" (e.g., "UpdateUser").
* Resources should use a singular noun (e.g., use "User" over "Users").
* Services should be named after the name of a service, omitting the word
"Service" and branding when possible (e.g., prefer "S3" over
"AmazonS3Service").


Member names
Expand Down
Loading