Skip to content

Commit

Permalink
Add naming recommendations
Browse files Browse the repository at this point in the history
Closes #1785
  • Loading branch information
mtdowling committed Jul 31, 2023
1 parent 59578f3 commit d1eefe6
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/source-2.0/guides/style-guide.rst
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").
* 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

0 comments on commit d1eefe6

Please sign in to comment.