Skip to content

Commit 912d936

Browse files
AhmedLeithyAhmedLeithy
authored
Removing the double 'l' in "Cancelled" and "Cancelling" (Azure#23342)
1 parent 77205be commit 912d936

13 files changed

+55
-52
lines changed

‎sdk/translation/Azure.AI.Translation.Document/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Get History of all submitted translation operations
231231
```C# Snippet:OperationsHistoryAsync
232232
int operationsCount = 0;
233233
int totalDocs = 0;
234-
int docsCancelled = 0;
234+
int docsCanceled = 0;
235235
int docsSucceeded = 0;
236236
int docsFailed = 0;
237237

@@ -246,7 +246,7 @@ await foreach (TranslationStatus translationStatus in client.GetTranslationStatu
246246

247247
operationsCount++;
248248
totalDocs += translationStatus.DocumentsTotal;
249-
docsCancelled += translationStatus.DocumentsCancelled;
249+
docsCanceled += translationStatus.DocumentsCanceled;
250250
docsSucceeded += translationStatus.DocumentsSucceeded;
251251
docsFailed += translationStatus.DocumentsFailed;
252252
}
@@ -255,7 +255,7 @@ Console.WriteLine($"# of operations: {operationsCount}");
255255
Console.WriteLine($"Total Documents: {totalDocs}");
256256
Console.WriteLine($"Succeeded Document: {docsSucceeded}");
257257
Console.WriteLine($"Failed Document: {docsFailed}");
258-
Console.WriteLine($"Cancelled Documents: {docsCancelled}");
258+
Console.WriteLine($"Canceled Documents: {docsCanceled}");
259259
```
260260

261261
### Start Translation with Multiple Inputs Asynchronously

‎sdk/translation/Azure.AI.Translation.Document/api/Azure.AI.Translation.Document.netstandard2.0.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,14 @@ public static partial class DocumentTranslationModelFactory
111111
public static Azure.AI.Translation.Document.DocumentStatus DocumentStatus(string id, System.Uri sourceDocumentUri, System.Uri translatedDocumentUri, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, string translatedTo, float progress, long charactersCharged) { throw null; }
112112
public static Azure.AI.Translation.Document.DocumentTranslationError DocumentTranslationError(Azure.AI.Translation.Document.DocumentTranslationErrorCode errorCode, string message, string target) { throw null; }
113113
public static Azure.AI.Translation.Document.FileFormat FileFormat(string format = null, System.Collections.Generic.IEnumerable<string> fileExtensions = null, System.Collections.Generic.IEnumerable<string> contentTypes = null, string defaultFormatVersion = null, System.Collections.Generic.IEnumerable<string> formatVersions = null) { throw null; }
114-
public static Azure.AI.Translation.Document.TranslationStatus TranslationStatus(string id, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, Azure.AI.Translation.Document.DocumentTranslationError error, int total, int failed, int success, int inProgress, int notYetStarted, int cancelled, long totalCharacterCharged) { throw null; }
114+
public static Azure.AI.Translation.Document.TranslationStatus TranslationStatus(string id, System.DateTimeOffset createdOn, System.DateTimeOffset lastModified, Azure.AI.Translation.Document.DocumentTranslationStatus status, Azure.AI.Translation.Document.DocumentTranslationError error, int total, int failed, int success, int inProgress, int notYetStarted, int canceled, long totalCharacterCharged) { throw null; }
115115
}
116116
public partial class DocumentTranslationOperation : Azure.PageableOperation<Azure.AI.Translation.Document.DocumentStatus>
117117
{
118118
protected DocumentTranslationOperation() { }
119119
public DocumentTranslationOperation(string translationId, Azure.AI.Translation.Document.DocumentTranslationClient client) { }
120120
public virtual System.DateTimeOffset CreatedOn { get { throw null; } }
121-
public virtual int DocumentsCancelled { get { throw null; } }
121+
public virtual int DocumentsCanceled { get { throw null; } }
122122
public virtual int DocumentsFailed { get { throw null; } }
123123
public virtual int DocumentsInProgress { get { throw null; } }
124124
public virtual int DocumentsNotStarted { get { throw null; } }
@@ -151,8 +151,8 @@ public virtual void Cancel(System.Threading.CancellationToken cancellationToken)
151151
private readonly object _dummy;
152152
private readonly int _dummyPrimitive;
153153
public DocumentTranslationStatus(string value) { throw null; }
154-
public static Azure.AI.Translation.Document.DocumentTranslationStatus Cancelled { get { throw null; } }
155-
public static Azure.AI.Translation.Document.DocumentTranslationStatus Cancelling { get { throw null; } }
154+
public static Azure.AI.Translation.Document.DocumentTranslationStatus Canceled { get { throw null; } }
155+
public static Azure.AI.Translation.Document.DocumentTranslationStatus Canceling { get { throw null; } }
156156
public static Azure.AI.Translation.Document.DocumentTranslationStatus Failed { get { throw null; } }
157157
public static Azure.AI.Translation.Document.DocumentTranslationStatus NotStarted { get { throw null; } }
158158
public static Azure.AI.Translation.Document.DocumentTranslationStatus Running { get { throw null; } }
@@ -219,7 +219,7 @@ public partial class TranslationStatus
219219
{
220220
internal TranslationStatus() { }
221221
public System.DateTimeOffset CreatedOn { get { throw null; } }
222-
public int DocumentsCancelled { get { throw null; } }
222+
public int DocumentsCanceled { get { throw null; } }
223223
public int DocumentsFailed { get { throw null; } }
224224
public int DocumentsInProgress { get { throw null; } }
225225
public int DocumentsNotStarted { get { throw null; } }

‎sdk/translation/Azure.AI.Translation.Document/samples/Sample3_OperationsHistory.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The sample below gets the total number of documents translated in all submitted
2222
```C# Snippet:OperationsHistoryAsync
2323
int operationsCount = 0;
2424
int totalDocs = 0;
25-
int docsCancelled = 0;
25+
int docsCanceled = 0;
2626
int docsSucceeded = 0;
2727
int docsFailed = 0;
2828

@@ -37,7 +37,7 @@ await foreach (TranslationStatus translationStatus in client.GetTranslationStatu
3737

3838
operationsCount++;
3939
totalDocs += translationStatus.DocumentsTotal;
40-
docsCancelled += translationStatus.DocumentsCancelled;
40+
docsCanceled += translationStatus.DocumentsCanceled;
4141
docsSucceeded += translationStatus.DocumentsSucceeded;
4242
docsFailed += translationStatus.DocumentsFailed;
4343
}
@@ -46,7 +46,7 @@ Console.WriteLine($"# of operations: {operationsCount}");
4646
Console.WriteLine($"Total Documents: {totalDocs}");
4747
Console.WriteLine($"Succeeded Document: {docsSucceeded}");
4848
Console.WriteLine($"Failed Document: {docsFailed}");
49-
Console.WriteLine($"Cancelled Documents: {docsCancelled}");
49+
Console.WriteLine($"Canceled Documents: {docsCanceled}");
5050
```
5151

5252
To see the full example source files, see:

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationModelFactory.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ long charactersCharged
101101
/// <param name="success">Sets the <see cref="StatusSummary.Success"/> and the <see cref="TranslationStatus.DocumentsSucceeded"/> properties.</param>
102102
/// <param name="inProgress">Sets the <see cref="StatusSummary.InProgress"/> and the <see cref="TranslationStatus.DocumentsInProgress"/> properties.</param>
103103
/// <param name="notYetStarted">Sets the <see cref="StatusSummary.NotYetStarted"/> and the <see cref="TranslationStatus.DocumentsNotStarted"/> properties.</param>
104-
/// <param name="cancelled">Sets the <see cref="StatusSummary.Cancelled"/> and the <see cref="TranslationStatus.DocumentsCancelled"/> properties.</param>
104+
/// <param name="canceled">Sets the <see cref="StatusSummary.Cancelled"/> and the <see cref="TranslationStatus.DocumentsCanceled"/> properties.</param>
105105
/// <param name="totalCharacterCharged">Sets the <see cref="StatusSummary.TotalCharacterCharged"/> and the <see cref="TranslationStatus.TotalCharactersCharged"/> properties.</param>
106106
/// <returns>A new instance of <see cref="Document.TranslationStatus"/> for mocking purposes.</returns>
107107
public static TranslationStatus TranslationStatus(
@@ -115,11 +115,11 @@ public static TranslationStatus TranslationStatus(
115115
int success,
116116
int inProgress,
117117
int notYetStarted,
118-
int cancelled,
118+
int canceled,
119119
long totalCharacterCharged
120120
)
121121
{
122-
StatusSummary newSummary = new StatusSummary(total, failed, success, inProgress, notYetStarted, cancelled, totalCharacterCharged);
122+
StatusSummary newSummary = new StatusSummary(total, failed, success, inProgress, notYetStarted, canceled, totalCharacterCharged);
123123
return new TranslationStatus(id, createdOn, lastModified, status, error, newSummary);
124124
}
125125
#endregion Statuses

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationOperation.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,16 @@ public class DocumentTranslationOperation : PageableOperation<DocumentStatus>
6666
public virtual int DocumentsNotStarted => _documentsNotStarted;
6767

6868
/// <summary>
69-
/// Number of documents cancelled.
69+
/// Number of documents canceled.
7070
/// </summary>
71-
public virtual int DocumentsCancelled => _documentsCancelled;
71+
public virtual int DocumentsCanceled => _documentsCanceled;
7272

7373
private int _documentsTotal;
7474
private int _documentsFailed;
7575
private int _documentsSucceeded;
7676
private int _documentsInProgress;
7777
private int _documentsNotStarted;
78-
private int _documentsCancelled;
78+
private int _documentsCanceled;
7979
private DateTimeOffset _createdOn;
8080
private DateTimeOffset _lastModified;
8181
private DocumentTranslationStatus _status;
@@ -288,10 +288,10 @@ private async ValueTask<Response> UpdateStatusAsync(bool async, CancellationToke
288288
_documentsInProgress = update.Value.DocumentsInProgress;
289289
_documentsSucceeded = update.Value.DocumentsSucceeded;
290290
_documentsNotStarted = update.Value.DocumentsNotStarted;
291-
_documentsCancelled = update.Value.DocumentsCancelled;
291+
_documentsCanceled = update.Value.DocumentsCanceled;
292292

293293
if (update.Value.Status == DocumentTranslationStatus.Succeeded
294-
|| update.Value.Status == DocumentTranslationStatus.Cancelled
294+
|| update.Value.Status == DocumentTranslationStatus.Canceled
295295
|| update.Value.Status == DocumentTranslationStatus.Failed)
296296
{
297297
_hasCompleted = true;

‎sdk/translation/Azure.AI.Translation.Document/src/DocumentTranslationStatus.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,12 @@ namespace Azure.AI.Translation.Document
1212
[CodeGenModel("Status")]
1313
public partial struct DocumentTranslationStatus
1414
{
15+
/// <summary> Canceled. </summary>
16+
[CodeGenMember("Cancelled")]
17+
public static DocumentTranslationStatus Canceled { get; } = new DocumentTranslationStatus(CanceledValue);
18+
19+
/// <summary> Canceling. </summary>
20+
[CodeGenMember("Cancelling")]
21+
public static DocumentTranslationStatus Canceling { get; } = new DocumentTranslationStatus(CancelingValue);
1522
}
1623
}

‎sdk/translation/Azure.AI.Translation.Document/src/Generated/Models/DocumentTranslationStatus.cs

Lines changed: 2 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/translation/Azure.AI.Translation.Document/src/TranslationStatus.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ public partial class TranslationStatus
5757
public int DocumentsNotStarted => Summary.NotYetStarted;
5858

5959
/// <summary>
60-
/// Number of documents cancelled.
60+
/// Number of documents canceled.
6161
/// </summary>
62-
public int DocumentsCancelled => Summary.Cancelled;
62+
public int DocumentsCanceled => Summary.Cancelled;
6363

6464
/// <summary>
6565
/// Total characters charged by the Document Translation service

‎sdk/translation/Azure.AI.Translation.Document/tests/DocumentTranslationClientLiveTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public async Task GetTranslationStatusesTest(bool usetokenCredential)
9090
TranslationStatus oneTranslation = translations[0];
9191
Assert.AreNotEqual(new DateTimeOffset(), oneTranslation.CreatedOn);
9292
Assert.AreNotEqual(new DateTimeOffset(), oneTranslation.LastModified);
93-
Assert.GreaterOrEqual(oneTranslation.DocumentsCancelled, 0);
93+
Assert.GreaterOrEqual(oneTranslation.DocumentsCanceled, 0);
9494
Assert.GreaterOrEqual(oneTranslation.DocumentsFailed, 0);
9595
Assert.GreaterOrEqual(oneTranslation.DocumentsInProgress, 0);
9696
Assert.GreaterOrEqual(oneTranslation.DocumentsNotStarted, 0);

‎sdk/translation/Azure.AI.Translation.Document/tests/GetAllTranslationsFilterTests.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ public partial class DocumentTranslationClientLiveTests
1616
public async Task<List<string>> CreateTranslationJobsAsync(DocumentTranslationClient client, int jobsCount = 1, int docsPerJob = 1, DocumentTranslationStatus jobTerminalStatus = default)
1717
{
1818
// create source container
19-
if (jobTerminalStatus == DocumentTranslationStatus.Cancelled)
19+
if (jobTerminalStatus == DocumentTranslationStatus.Canceled)
2020
{
21-
docsPerJob = 20; // in order to avoid job completing before cancelling
21+
docsPerJob = 20; // in order to avoid job completing before canceling
2222
}
2323
var testDocs = CreateDummyTestDocuments(count: docsPerJob);
2424
var sourceContainer = await CreateSourceContainerAsync(testDocs);
@@ -35,7 +35,7 @@ public async Task<List<string>> CreateTranslationJobsAsync(DocumentTranslationCl
3535
{
3636
await translationOp.WaitForCompletionAsync();
3737
}
38-
else if (jobTerminalStatus == DocumentTranslationStatus.Cancelled)
38+
else if (jobTerminalStatus == DocumentTranslationStatus.Canceled)
3939
{
4040
await translationOp.CancelAsync(default);
4141
Thread.Sleep(3000); // wait for cancel status to propagate!
@@ -53,23 +53,23 @@ public async Task GetTranslationStatusesFilterByStatusTest()
5353

5454
// create test jobs
5555
await CreateTranslationJobsAsync(client, jobsCount: 1, docsPerJob: 1, jobTerminalStatus: DocumentTranslationStatus.Succeeded);
56-
var cancelledIds = await CreateTranslationJobsAsync(client, jobsCount: 1, jobTerminalStatus: DocumentTranslationStatus.Cancelled);
56+
var canceledIds = await CreateTranslationJobsAsync(client, jobsCount: 1, jobTerminalStatus: DocumentTranslationStatus.Canceled);
5757

5858
// list translations with filter
59-
var cancelledStatusList = new List<DocumentTranslationStatus> {
60-
DocumentTranslationStatus.Cancelled,
61-
DocumentTranslationStatus.Cancelling
59+
var canceledStatusList = new List<DocumentTranslationStatus> {
60+
DocumentTranslationStatus.Canceled,
61+
DocumentTranslationStatus.Canceling
6262
};
6363
var filter = new TranslationFilter
6464
{
65-
Statuses = { cancelledStatusList[0], cancelledStatusList[1] }
65+
Statuses = { canceledStatusList[0], canceledStatusList[1] }
6666
};
6767
var filteredTranslations = await client.GetTranslationStatusesAsync(filter: filter).ToEnumerableAsync();
6868
var filteredIds = filteredTranslations.Select(t => t.Id).ToList();
6969

7070
// assert
71-
Assert.That(filteredTranslations.All(t => cancelledStatusList.Contains(t.Status)));
72-
Assert.True(cancelledIds.All(cancelledId => filteredIds.Contains(cancelledId)));
71+
Assert.That(filteredTranslations.All(t => canceledStatusList.Contains(t.Status)));
72+
Assert.True(canceledIds.All(canceledId => filteredIds.Contains(canceledId)));
7373
}
7474

7575
[RecordedTest]

0 commit comments

Comments
 (0)