diff --git a/src/Sqids/Sqids.csproj b/src/Sqids/Sqids.csproj index 9187a98..bc73eee 100644 --- a/src/Sqids/Sqids.csproj +++ b/src/Sqids/Sqids.csproj @@ -8,7 +8,7 @@ Library Sqids - 1.0.2 + 1.0.3 Official .NET port of Sqids. Generate short YouTube-looking IDs from numbers. Sqids;ID-generator;number-obfuscator;YouTube-ID https://raw.githubusercontent.com/sqids/sqids-dotnet/main/icon.png diff --git a/src/Sqids/SqidsEncoder.cs b/src/Sqids/SqidsEncoder.cs index 7786410..8269add 100644 --- a/src/Sqids/SqidsEncoder.cs +++ b/src/Sqids/SqidsEncoder.cs @@ -1,7 +1,7 @@ namespace Sqids; /// -/// The Sqids encoder/decoder. +/// The Sqids encoder/decoder. This is the main class. /// public sealed class SqidsEncoder { @@ -14,7 +14,7 @@ public sealed class SqidsEncoder /// /// The minimum numeric value that can be encoded/decoded using . - /// It's always zero across all ports of Sqids. + /// This is always zero across all ports of Sqids. /// public const int MinValue = 0; @@ -35,7 +35,7 @@ public SqidsEncoder() : this(new()) { } /// /// The custom options. /// All properties of are optional and will fall back to their - /// defaults unless explicitly set. + /// defaults if not explicitly set. /// public SqidsEncoder(SqidsOptions options) { @@ -209,13 +209,13 @@ private string Encode(ReadOnlySpan numbers, bool partitioned = false) } /// - /// Decodes a string into its original . + /// Decodes an ID into numbers. /// /// The encoded ID. /// - /// A collection of integers containing the decoded number(s); or empty an collection if the - /// input string is null, empty, contains fewer characters than the configured minimum length, - /// or includes characters not found in the alphabet. + /// An array of integers containing the decoded number(s) (it would contain only one element + /// if the ID represents a single number); or an empty array if the input ID is null, + /// empty, or includes characters not found in the alphabet. /// public int[] Decode(ReadOnlySpan id) { diff --git a/src/Sqids/SqidsOptions.cs b/src/Sqids/SqidsOptions.cs index 29504b5..cf61405 100644 --- a/src/Sqids/SqidsOptions.cs +++ b/src/Sqids/SqidsOptions.cs @@ -2,8 +2,7 @@ namespace Sqids; /// /// The configuration options for . -/// All properties are optional; any property that isn't explicitly specified when passing an -/// instance of this class to the constructor of will fall back to its +/// All properties are optional; any property that isn't explicitly specified will fall back to its /// default value. /// public sealed class SqidsOptions