Root namespace renamed from Calabonga.Results to Calabonga.OperationResults

Author: Calabonga

src/Calabonga.Results.Tests/OperationResultTests.cs

@@ -1,4 +1,5 @@
-using Xunit;
+using Calabonga.OperationResults;
+using Xunit;
 
 namespace Calabonga.Results.Tests;
 

src/Calabonga.Results.Tests/ResultFixture.cs

@@ -1,4 +1,6 @@
-namespace Calabonga.Results.Tests;
+using Calabonga.OperationResults;
+
+namespace Calabonga.Results.Tests;
 
 public class ResultFixture
 {

src/Calabonga.Results/Calabonga.Results.csproj

@@ -5,7 +5,7 @@
 		<Nullable>enable</Nullable>
 		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
 		<Title>Calabonga.Results</Title>
-		<Version>1.0.2</Version>
+		<Version>1.1.0</Version>
 		<Authors>Calabonga</Authors>
 		<Company>Calabonga SOFT</Company>
 		<Product></Product>
@@ -17,11 +17,12 @@
 		<RepositoryUrl>https://github.com/Calabonga/Calabonga.Results</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
 		<PackageTags>calabonga web api operation result different types rfc7807 aspnetcore backend</PackageTags>
-		<PackageReleaseNotes>Redundant Operation properties are hided using an internal modifier. Some unit-tests added.</PackageReleaseNotes>
+		<PackageReleaseNotes>Root namespace renamed from Calabonga.Results to Calabonga.OperationResults</PackageReleaseNotes>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageId></PackageId>
 		<PackageIconUrl>https://www.calabonga.net/images/logo.png</PackageIconUrl>
 		<IncludeSymbols>False</IncludeSymbols>
+		<RootNamespace>Calabonga.OperationResults</RootNamespace>
 	</PropertyGroup>
 
 	<ItemGroup>

src/Calabonga.Results/ErrorResult.cs

@@ -1,9 +1,18 @@
-namespace Calabonga.Results
+namespace Calabonga.OperationResults
 {
+    /// <summary>
+    /// Operation response result with error
+    /// </summary>
     public struct ErrorResult { }
 
+    /// <summary>
+    /// Operation response result with error
+    /// </summary>
     public struct ErrorResult<T>
     {
+        /// <summary>
+        /// Operation error
+        /// </summary>
         internal readonly T Error;
 
         internal ErrorResult(T error) => Error = error;

src/Calabonga.Results/Operation.cs

@@ -1,4 +1,4 @@
-namespace Calabonga.Results
+namespace Calabonga.OperationResults
 {
     /// <summary>
     /// The operation with some Result

src/Calabonga.Results/OperationEmpty.cs

@@ -1,10 +1,13 @@
-namespace Calabonga.Results
+namespace Calabonga.OperationResults
 {
     /// <summary>
     /// OperationEmpty of operation (without Result and Error fields)
     /// </summary>
     public struct OperationEmpty
     {
+        /// <summary>
+        /// Indicate that operation successfully completed
+        /// </summary>
         public bool Ok { get; }
 
         private OperationEmpty(bool ok)
@@ -40,6 +43,9 @@ public struct OperationEmpty<T>
     {
         public readonly T Error;
 
+        /// <summary>
+        /// Indicate that operation successfully completed
+        /// </summary>
         public bool Ok { get; }
 
         private OperationEmpty(bool ok)
@@ -81,6 +87,9 @@ public readonly struct OperationEmpty<T, T1>
     {
         public readonly object? Error;
 
+        /// <summary>
+        /// Indicate that operation successfully completed
+        /// </summary>
         public bool Ok { get; }
 
         private OperationEmpty(bool ok)
@@ -128,6 +137,9 @@ public readonly struct OperationEmpty<T, T1, T2>
     {
         public readonly object? Error;
 
+        /// <summary>
+        /// Indicate that operation successfully completed
+        /// </summary>
         public bool Ok { get; }
 
 

src/Calabonga.Results/OperationHelpers.cs

@@ -1,4 +1,4 @@
-namespace Calabonga.Results
+namespace Calabonga.OperationResults
 {
     /// <summary>
     /// Operation results extensions

src/Calabonga.Results/README.md

@@ -2,13 +2,17 @@
 
 ## Описание
 
-Данный nuget-пакет является продолжением другого пакета `OperationResultCore`, который уже исчерпал свои возможности и пришло время двигаться дальше. В старой версии был только один недостаток, который перекрывал все остальные плюсы - невозможность десериализовать объект из строки. Для выполнения десериализации приходилось реализовывать конверторы. В новом nuget-пакете `Calabonga.Result` реализация стандарта RFC7807 построена по стилю на язык rust. При этом всё максимально упрощено для удобства.
-
+Данный nuget-пакет является продолжением другого пакета `OperationResultCore`, который уже исчерпал свои возможности и пришло время двигаться дальше. В старой версии был только один недостаток, который перекрывал все остальные плюсы - невозможность универсально реагировать на тип возвращаемого результата и десереализация из строки. Для выполнения десериализации приходилось реализовывать конверторы. В новом nuget-пакете `Calabonga.Result` реализация стандарта RFC7807 построена по стилю на язык rust. При этом всё максимально упрощено для удобства, таким образом, десериализация никогда не требуется (или почти никогда).
 ## English
 Some helpful Results as an implementation of RFC7807. In other words, it's simple wrapper for result operation for any returned data from API backend implemented on Rust-style approach.
 
 ## Version history
 
+### 2024-06-03 v1.1.0
+
+* Root namespace renamed from Calabonga.Results to Calabonga.OperationResults
+* Add some summaries for properties and methods
+
 ### 2024-02-06 v1.0.2
 
 * First release

src/Calabonga.Results/SuccessResult.cs

@@ -1,4 +1,4 @@
-namespace Calabonga.Results
+namespace Calabonga.OperationResults
 {
     /// <summary>
     /// Default success result