Skip to content

Commit e8f754f

Browse files
author
Oren (electricessence)
committed
Documentation update/correction.
1 parent 678c0fe commit e8f754f

File tree

6 files changed

+415
-54
lines changed

6 files changed

+415
-54
lines changed

Extensions.Transactions.cs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static partial class Extensions
1717
/// <param name="connection">The connection to transact with.</param>
1818
/// <param name="conditionalAction">The handler to execute while a transaction is pending. Returning a 'Commit' value of true signals to commit the transaction.</param>
1919
/// <param name="token">A optional token that if cancelled will cause this transaction to be aborted or rolled-back.</param>
20-
/// <returns>True if the transaction was committed.</returns>
20+
/// <returns>The value retured from the conditional action.</returns>
2121
public static (bool Commit, T Value) ExecuteTransactionConditional<TConn, T>(
2222
this TConn connection, Func<TConn, (bool Commit, T Value)> conditionalAction, CancellationToken? token = null)
2323
where TConn : DbConnection
@@ -64,7 +64,6 @@ public static bool ExecuteTransactionConditional<TConn>(
6464

6565
/// <summary>
6666
/// Begins a transaction before executing the action. Commits if there are no exceptions and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
67-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
6867
/// </summary>
6968
/// <typeparam name="TConn">The connection type.</typeparam>
7069
/// <typeparam name="T">The value returned from the action.</typeparam>
@@ -79,7 +78,6 @@ public static T ExecuteTransaction<TConn, T>(
7978

8079
/// <summary>
8180
/// Begins a transaction before executing the action. Commits if there are no exceptions and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
82-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
8381
/// </summary>
8482
/// <typeparam name="TConn">The connection type.</typeparam>
8583
/// <param name="connection">The connection to transact with.</param>
@@ -93,7 +91,6 @@ public static void ExecuteTransaction<TConn>(
9391

9492
/// <summary>
9593
/// Begins a transaction before executing the action. Commits if there are no exceptions, the 'Commit' value from the action is true, and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
96-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
9794
/// </summary>
9895
/// <typeparam name="TConn">The connection type.</typeparam>
9996
/// <typeparam name="T">The value returned from the action.</typeparam>
@@ -134,7 +131,6 @@ public static void ExecuteTransaction<TConn>(
134131

135132
/// <summary>
136133
/// Begins a transaction before executing the action. Commits if there are no exceptions, the 'Commit' value from the action is true, and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
137-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
138134
/// </summary>
139135
/// <typeparam name="TConn">The connection type.</typeparam>
140136
/// <typeparam name="T">The value returned from the action.</typeparam>
@@ -149,7 +145,6 @@ public static async Task<bool> ExecuteTransactionConditionalAsync<TConn, T>(
149145

150146
/// <summary>
151147
/// Begins a transaction before executing the action. Commits if there are no exceptions and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
152-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
153148
/// </summary>
154149
/// <typeparam name="TConn">The connection type.</typeparam>
155150
/// <typeparam name="T">The value returned from the action.</typeparam>
@@ -164,7 +159,6 @@ public static async Task<T> ExecuteTransactionAsync<TConn, T>(
164159

165160
/// <summary>
166161
/// Begins a transaction before executing the action. Commits if there are no exceptions and the optional provided token is not cancelled. Otherwise rolls-back the transaction.
167-
/// If the token provided is already cancelled, nothing is done and the default value is returned.
168162
/// </summary>
169163
/// <typeparam name="TConn">The connection type.</typeparam>
170164
/// <param name="connection">The connection to transact with.</param>

Open.Database.Extensions.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
<Description>Useful set of utilities and abstractions for simplifying modern data-access operations and ensuring DI compatibility.</Description>
1212
<RepositoryUrl>https://github.com/electricessence/Open.Database.Extensions</RepositoryUrl>
1313
<RepositoryType>git</RepositoryType>
14-
<Version>5.7.0</Version>
15-
<AssemblyVersion>5.7.0.0</AssemblyVersion>
16-
<FileVersion>5.7.0.0</FileVersion>
14+
<Version>5.7.1</Version>
15+
<AssemblyVersion>5.7.1.0</AssemblyVersion>
16+
<FileVersion>5.7.1.0</FileVersion>
1717
<PackageReleaseNotes>Updated transaction methods be more controllable and explicit. Always passing the connection as a parameter for the handler allows for static handler methods.
1818

1919
Added cancellation tokens to all applicable extensions.</PackageReleaseNotes>

docs/Documentation.xml

Lines changed: 1 addition & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)