Merge pull request #213 from hankovich/feature/make_ok_obsolete

Add [Obsolete] on top of Result.Ok methods
vkhorikov · Jul 10, 2020 · c10e048 · c10e048
2 parents 98eef75 + 96a14d2
commit c10e048
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 11 deletions.
diff --git a/CSharpFunctionalExtensions/Result/Obsolete/Ok.cs b/CSharpFunctionalExtensions/Result/Obsolete/Ok.cs
@@ -1,22 +1,18 @@
-namespace CSharpFunctionalExtensions
+using System;
+
+namespace CSharpFunctionalExtensions
 {
     public partial struct Result
     {
-        /// <summary>
-        /// Deprecated. Use Success() instead.
-        /// </summary>
+        [Obsolete("Use Success() instead.")]
         public static Result Ok()
             => Success();
 
-        /// <summary>
-        /// Deprecated. Use Success() instead.
-        /// </summary>
+        [Obsolete("Use Success() instead.")]
         public static Result<T> Ok<T>(T value)
             => Success(value);
 
-        /// <summary>
-        /// Deprecated. Use Success() instead.
-        /// </summary>
+        [Obsolete("Use Success() instead.")]
         public static Result<T, E> Ok<T, E>(T value)
             => Success<T, E>(value);
     }

diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ return _customerRepository.GetById(id)
 return _customerRepository.GetById(id)
     .ToResult("Customer with such Id is not found: " + id)
     .Ensure(customer => customer.CanBePromoted(), "The customer has the highest status possible")
-    .WithTransactionScope(customer => Result.Ok(customer)
+    .WithTransactionScope(customer => Result.Success(customer)
         .Tap(customer => customer.Promote())
         .Tap(customer => customer.ClearAppointments()))
     .Tap(customer => _emailGateway.SendPromotionNotification(customer.PrimaryEmail, customer.Status))