Skip to content

Commit 7607ea3

Browse files
committed
CODE RUB: Wording changes
1 parent a3d258d commit 7607ea3

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

2. Services/2. Services.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ File versioning governs how changes to models and services are managed and commu
247247

248248
#### 2.0.3.0 Model Versioning
249249

250-
When a model’s structure or behaviour is changed (including adding, removing, or modifying properties), a new version of the model must be created.
250+
When a model’s structure is changed (including adding, removing, or modifying properties), a new version of the model must be created.
251251
The version number must be incremented, and both the model file and its path must reflect the new version. This preserves backward compatibility and allows consumers to upgrade at their discretion.
252252

253253
New model versions must be created alongside the previous version and organised in a versioned subfolder.
@@ -367,7 +367,8 @@ The new V2 model service only exposes the latest behavior under the implied V0 n
367367
The parameter name in the method signature does not include the model version,
368368
as it is already reflected in the service file name and path.
369369

370-
**TIP:** Use XML documentation comments to clearly indicate the versioning details of each method, including which model version it corresponds to and any behavior changes. This provides clarity for developers consuming the service and helps maintain a clear history of changes over time.
370+
TIP: Use XML documentation comments to indicate versioning details only at exposure layers where consumers do not have access to the source code. This ensures external consumers understand which model version is used and any behaviour changes, while avoiding unnecessary comments within internal or non-exposed layers where the code itself is already visible.
371+
371372
**Example:**
372373
```csharp
373374
internal interface IEventAddressV3Service

0 commit comments

Comments
 (0)