From 78a0a68cd161e91e80d740e39e8548532e236d5d Mon Sep 17 00:00:00 2001 From: Brian Chavez Date: Mon, 1 Oct 2018 14:41:05 -0700 Subject: [PATCH] Typos/spelling errors in XML doc comments and source. #Hacktoberfest (#3039) --- benchmarkapps/Crankier/Worker.cs | 6 +++--- src/Common/BinaryMessageParser.cs | 2 +- src/Common/JsonUtils.cs | 2 +- src/Common/Utf8BufferTextReader.cs | 2 +- src/Common/Utf8BufferTextWriter.cs | 2 +- .../HttpConnection.cs | 2 +- .../Internal/HttpConnectionDispatcher.cs | 4 ++-- .../HubConnection.cs | 2 +- .../Protocol/HandshakeResponseMessage.cs | 2 +- src/Microsoft.AspNetCore.SignalR.Core/IUserIdProvider.cs | 2 +- .../ServerSentEventsTransportTests.cs | 2 +- test/Microsoft.AspNetCore.SignalR.Redis.Tests/Docker.cs | 2 +- 12 files changed, 15 insertions(+), 15 deletions(-) diff --git a/benchmarkapps/Crankier/Worker.cs b/benchmarkapps/Crankier/Worker.cs index ed41709659..6a39616574 100644 --- a/benchmarkapps/Crankier/Worker.cs +++ b/benchmarkapps/Crankier/Worker.cs @@ -68,7 +68,7 @@ namespace Microsoft.AspNetCore.SignalR.Crankier await client.CreateAndStartConnectionAsync(targetAddress, transportType); } - Log("Connections connected succesfully"); + Log("Connections connected successfully"); } public Task StartTestAsync(TimeSpan sendInterval, int sendBytes) @@ -80,7 +80,7 @@ namespace Microsoft.AspNetCore.SignalR.Crankier client.StartTest(sendBytes, sendInterval); } - Log("Test started succesfully"); + Log("Test started successfully"); return Task.CompletedTask; } @@ -98,7 +98,7 @@ namespace Microsoft.AspNetCore.SignalR.Crankier } _sendStatusCts.Cancel(); - Log("Connections stopped succesfully"); + Log("Connections stopped successfully"); _targetConnectionCount = 0; return Task.CompletedTask; diff --git a/src/Common/BinaryMessageParser.cs b/src/Common/BinaryMessageParser.cs index 0f76cc8c72..b911f65e6e 100644 --- a/src/Common/BinaryMessageParser.cs +++ b/src/Common/BinaryMessageParser.cs @@ -27,7 +27,7 @@ namespace Microsoft.AspNetCore.Internal // remaining bits (%x0000000) are the lowest bits of the value. The most significant bit of the second // byte is 0 meaning this is last byte of the VarInt. The actual value bits (%x0101001) need to be // prepended to the bits we already read so the values is %01010010000000 i.e. 0x1480 (5248) - // We support paylads up to 2GB so the biggest number we support is 7fffffff which when encoded as + // We support payloads up to 2GB so the biggest number we support is 7fffffff which when encoded as // VarInt is 0xFF 0xFF 0xFF 0xFF 0x07 - hence the maximum length prefix is 5 bytes. var length = 0U; diff --git a/src/Common/JsonUtils.cs b/src/Common/JsonUtils.cs index a5ab92ecec..4b09210210 100644 --- a/src/Common/JsonUtils.cs +++ b/src/Common/JsonUtils.cs @@ -155,7 +155,7 @@ namespace Microsoft.AspNetCore.Internal public static bool ReadForType(JsonTextReader reader, Type type) { - // Explicity read values as dates from JSON with reader. + // Explicitly read values as dates from JSON with reader. // We do this because otherwise dates are read as strings // and the JsonSerializer will use a conversion method that won't // preserve UTC in DateTime.Kind for UTC ISO8601 dates diff --git a/src/Common/Utf8BufferTextReader.cs b/src/Common/Utf8BufferTextReader.cs index 8927373370..f78c878b1d 100644 --- a/src/Common/Utf8BufferTextReader.cs +++ b/src/Common/Utf8BufferTextReader.cs @@ -34,7 +34,7 @@ namespace Microsoft.AspNetCore.SignalR.Internal reader = new Utf8BufferTextReader(); } - // Taken off the the thread static + // Taken off the thread static _cachedInstance = null; #if DEBUG if (reader._inUse) diff --git a/src/Common/Utf8BufferTextWriter.cs b/src/Common/Utf8BufferTextWriter.cs index f8592069bd..eb57dc2e36 100644 --- a/src/Common/Utf8BufferTextWriter.cs +++ b/src/Common/Utf8BufferTextWriter.cs @@ -43,7 +43,7 @@ namespace Microsoft.AspNetCore.Internal writer = new Utf8BufferTextWriter(); } - // Taken off the the thread static + // Taken off the thread static _cachedInstance = null; #if DEBUG if (writer._inUse) diff --git a/src/Microsoft.AspNetCore.Http.Connections.Client/HttpConnection.cs b/src/Microsoft.AspNetCore.Http.Connections.Client/HttpConnection.cs index e45d6f70a0..80f9c88d54 100644 --- a/src/Microsoft.AspNetCore.Http.Connections.Client/HttpConnection.cs +++ b/src/Microsoft.AspNetCore.Http.Connections.Client/HttpConnection.cs @@ -529,7 +529,7 @@ namespace Microsoft.AspNetCore.Http.Connections.Client httpMessageHandler = new AccessTokenHttpMessageHandler(httpMessageHandler, this); } - // Wrap message handler after HttpMessageHandlerFactory to ensure not overriden + // Wrap message handler after HttpMessageHandlerFactory to ensure not overridden httpMessageHandler = new LoggingHttpMessageHandler(httpMessageHandler, _loggerFactory); var httpClient = new HttpClient(httpMessageHandler); diff --git a/src/Microsoft.AspNetCore.Http.Connections/Internal/HttpConnectionDispatcher.cs b/src/Microsoft.AspNetCore.Http.Connections/Internal/HttpConnectionDispatcher.cs index 3b2d467673..18ed1f1ee6 100644 --- a/src/Microsoft.AspNetCore.Http.Connections/Internal/HttpConnectionDispatcher.cs +++ b/src/Microsoft.AspNetCore.Http.Connections/Internal/HttpConnectionDispatcher.cs @@ -299,7 +299,7 @@ namespace Microsoft.AspNetCore.Http.Connections.Internal // If the status code is a 204 it means the connection is done if (context.Response.StatusCode == StatusCodes.Status204NoContent) { - // Cancel current request to release any waiting poll and let dispose aquire the lock + // Cancel current request to release any waiting poll and let dispose acquire the lock currentRequestTcs.TrySetCanceled(); // We should be able to safely dispose because there's no more data being written @@ -312,7 +312,7 @@ namespace Microsoft.AspNetCore.Http.Connections.Internal } else if (resultTask.IsFaulted) { - // Cancel current request to release any waiting poll and let dispose aquire the lock + // Cancel current request to release any waiting poll and let dispose acquire the lock currentRequestTcs.TrySetCanceled(); // transport task was faulted, we should remove the connection diff --git a/src/Microsoft.AspNetCore.SignalR.Client.Core/HubConnection.cs b/src/Microsoft.AspNetCore.SignalR.Client.Core/HubConnection.cs index bf15256716..743f810784 100644 --- a/src/Microsoft.AspNetCore.SignalR.Client.Core/HubConnection.cs +++ b/src/Microsoft.AspNetCore.SignalR.Client.Core/HubConnection.cs @@ -714,7 +714,7 @@ namespace Microsoft.AspNetCore.SignalR.Client { // Adjust consumed and examined to point to the end of the handshake // response, this handles the case where invocations are sent in the same payload - // as the the negotiate response. + // as the negotiate response. consumed = buffer.Start; examined = consumed; diff --git a/src/Microsoft.AspNetCore.SignalR.Common/Protocol/HandshakeResponseMessage.cs b/src/Microsoft.AspNetCore.SignalR.Common/Protocol/HandshakeResponseMessage.cs index 4288ea94e2..968da823e5 100644 --- a/src/Microsoft.AspNetCore.SignalR.Common/Protocol/HandshakeResponseMessage.cs +++ b/src/Microsoft.AspNetCore.SignalR.Common/Protocol/HandshakeResponseMessage.cs @@ -21,7 +21,7 @@ namespace Microsoft.AspNetCore.SignalR.Protocol /// /// Initializes a new instance of the class. /// - /// An optional response error message. A null error message indicates a succesful handshake. + /// An optional response error message. A null error message indicates a successful handshake. public HandshakeResponseMessage(string error) { // Note that a response with an empty string for error in the JSON is considered an errored response diff --git a/src/Microsoft.AspNetCore.SignalR.Core/IUserIdProvider.cs b/src/Microsoft.AspNetCore.SignalR.Core/IUserIdProvider.cs index 0053705598..9f7d540154 100644 --- a/src/Microsoft.AspNetCore.SignalR.Core/IUserIdProvider.cs +++ b/src/Microsoft.AspNetCore.SignalR.Core/IUserIdProvider.cs @@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.SignalR /// /// Gets the user ID for the specified connection. /// - /// The connection get get the user ID for. + /// The connection to get the user ID for. /// The user ID for the specified connection. string GetUserId(HubConnectionContext connection); } diff --git a/test/Microsoft.AspNetCore.SignalR.Client.Tests/ServerSentEventsTransportTests.cs b/test/Microsoft.AspNetCore.SignalR.Client.Tests/ServerSentEventsTransportTests.cs index 978f1afa09..47100aa5d1 100644 --- a/test/Microsoft.AspNetCore.SignalR.Client.Tests/ServerSentEventsTransportTests.cs +++ b/test/Microsoft.AspNetCore.SignalR.Client.Tests/ServerSentEventsTransportTests.cs @@ -327,7 +327,7 @@ namespace Microsoft.AspNetCore.SignalR.Client.Tests await sseTransport.Output.WriteAsync(new byte[] { 0x42 }); - // For for send request to be in progress + // For send request to be in progress await sendSyncPoint.WaitForSyncPoint(); var stopTask = sseTransport.StopAsync(); diff --git a/test/Microsoft.AspNetCore.SignalR.Redis.Tests/Docker.cs b/test/Microsoft.AspNetCore.SignalR.Redis.Tests/Docker.cs index aec3a9adcf..f60e557ae5 100644 --- a/test/Microsoft.AspNetCore.SignalR.Redis.Tests/Docker.cs +++ b/test/Microsoft.AspNetCore.SignalR.Redis.Tests/Docker.cs @@ -81,7 +81,7 @@ namespace Microsoft.AspNetCore.SignalR.Redis.Tests // create and run docker container, remove automatically when stopped, map 6379 from the container to 6379 localhost // use static name 'redisTestContainer' so if the container doesn't get removed we don't keep adding more // use redis base docker image - // 20 second timeout to allow redis image to be downloaded, should be a rare occurance, only happening when a new version is released + // 20 second timeout to allow redis image to be downloaded, should be a rare occurrence, only happening when a new version is released RunProcessAndThrowIfFailed(_path, $"run --rm -p 6379:6379 --name {_dockerContainerName} -d redis", "redis", logger, TimeSpan.FromSeconds(20)); // inspect the redis docker image and extract the IPAddress. Necessary when running tests from inside a docker container, spinning up a new docker container for redis