DATAMONGO-2075 - Polishing.

Tweaks to Javadoc and reference docs to align with american-english spelling.

Original pull request: #606.
This commit is contained in:
Mark Paluch
2018-09-03 11:19:25 +02:00
parent 04e53316c6
commit a1ac2f7c1d
2 changed files with 8 additions and 7 deletions

View File

@@ -51,8 +51,8 @@ import com.mongodb.client.ClientSession;
* By default failure of a {@literal commit} operation raises a {@link TransactionSystemException}. One may override
* {@link #doCommit(MongoTransactionObject)} to implement the
* <a href="https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation">Retry Commit Operation</a>
* behaviour as outlined in the MongoDB reference manual.
*
* behavior as outlined in the MongoDB reference manual.
*
* @author Christoph Strobl
* @author Mark Paluch
* @currentRead Shadow's Edge - Brent Weeks
@@ -75,7 +75,7 @@ public class MongoTransactionManager extends AbstractPlatformTransactionManager
* <p />
* Optionally it is possible to set default {@link TransactionOptions transaction options} defining
* {@link com.mongodb.ReadConcern} and {@link com.mongodb.WriteConcern}.
*
*
* @see #setDbFactory(MongoDbFactory)
* @see #setTransactionSynchronization(int)
*/
@@ -227,8 +227,9 @@ public class MongoTransactionManager extends AbstractPlatformTransactionManager
* } while (--retries > 0);
* </pre>
* </code>
*
*
* @param transactionObject never {@literal null}.
* @throws Exception in case of transaction errors.
*/
protected void doCommit(MongoTransactionObject transactionObject) throws Exception {
transactionObject.commitTransaction();

View File

@@ -317,11 +317,11 @@ structures in place.
*Transient Errors*
MongoDB can add special labels to errors raised during a transactional execution. Those may indicate transient failures
that might vanish by simply retrying the operation.
MongoDB can add special labels to errors raised during transactional execution. Those may indicate transient failures
that might vanish by merely retrying the operation.
We highly recommend https://github.com/spring-projects/spring-retry[Spring Retry] for those purposes. Nevertheless
one may override `MongoTransactionManager#doCommit(MongoTransactionObject)` to implement a https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation[Retry Commit Operation]
behaviour as outlined in the MongoDB reference manual.
behavior as outlined in the MongoDB reference manual.
*Count*