Skip to content

Commit 19707b0

Browse files
mikekistlertg-msft
andauthored
Apply suggestions from PR review
Co-authored-by: tg-msft <[email protected]>
1 parent 4736c10 commit 19707b0

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

azure/ConsiderationsForServiceDesign.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ As you build out your service and API, there are a number of decisions that can
8686

8787
## Use Good Names
8888

89-
Good names for resources, properties, operations, and parameters are essential to a good developer experience.
89+
Good names for resources, properties, operations, and parameters are essential to a great developer experience.
9090

9191
Resources are described by nouns. Resource and property names must be descriptive and easy for customers to understand.
9292
Avoid names that refer to service implementation details, e.g. "TreeLeafNode", or simply describe the structure of value without
@@ -128,7 +128,7 @@ For example, `expirationDays` as `int` and not `expiration` as `date-time`.
128128

129129
:warning: **YOU SHOULD NOT** use acronyms or abbreviations unless they are broadly understood for example, "ID" or "URL", but not "Num" for "number".
130130

131-
:warning: **YOU SHOULD NOT** use names that are reserved words in widely used programming languages.
131+
:warning: **YOU SHOULD NOT** use names that are reserved words in widely used programming languages (including C#, Java, JavaScript/TypeScript, Python, C++, and Go).
132132

133133
:no_entry: **DO NOT** use "is" prefix in names of `boolean` values.
134134

@@ -148,7 +148,7 @@ The following are recommended names for properties that match the associated des
148148

149149
### `name` vs `id`
150150

151-
:heavy_check_mark: **DO** use "Id" suffix for the name of rhe identifier of a resource.
151+
:heavy_check_mark: **DO** use "Id" suffix for the name of the identifier of a resource.
152152

153153
This holds even in the case where the identifier is assigned by the user with a PUT/PATCH method.
154154

0 commit comments

Comments
 (0)