Fixed incorrect code snippets in docstring (#62)

awslabs · Jun 4, 2021 · eb7b182 · eb7b182
1 parent e28b769
commit eb7b182
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,16 +1,21 @@
-# 2.3.0
+# 2.3.1
+
+### :bug: Fixed
+* Fix incorrect code snippet in docstrings.
+
+# [2.3.0](https://github.com/awslabs/amazon-qldb-driver-java/releases/tag/v2.3.0)
 
 ### :hammer_and_wrench: Improvements
 * Add `httpClientBuilder` attribute to `QldbDriverBuilder` to support use of custom HTTP clients.
     * The following code demonstrates how to use it:
         ```
         QldbSessionClientBuilder sessionClientBuilder = QldbSessionClient.builder();
-        
-        QldbDriverBuilder builder = QldbDriver
+
+        QldbDriver qldbDriver = QldbDriver
             .builder()
-            .ledger(ledger);
+            .ledger(ledger)
             .maxConcurrentTransactions(poolLimit)
-            .transactionRetryPolicy(TransactionRetryPolicy.builder().maxNumberOfRetries(retryLimit).build());
+            .transactionRetryPolicy(TransactionRetryPolicy.builder().maxNumberOfRetries(retryLimit).build())
             .sessionClientBuilder(sessionClientBuilder)
             .httpClientBuilder(ApacheHttpClient.builder().maxConnections(maxConnections))
             .build();

diff --git a/pom.xml b/pom.xml
@@ -18,7 +18,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>software.amazon.qldb</groupId>
     <artifactId>amazon-qldb-driver-java</artifactId>
-    <version>2.3.0</version>
+    <version>2.3.1</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

diff --git a/src/main/java/software/amazon/qldb/QldbDriverBuilder.java b/src/main/java/software/amazon/qldb/QldbDriverBuilder.java
@@ -26,14 +26,14 @@
  * <pre>{@code
  *     QldbSessionClientBuilder sessionClientBuilder = QldbSessionClient.builder();
  *
- *     QldbDriverBuilder builder = QldbDriver
- *          .builder()
- *          .ledger(ledger);
- *          .maxConcurrentTransactions(poolLimit)
- *          .transactionRetryPolicy(TransactionRetryPolicy.builder().maxNumberOfRetries(retryLimit).build());
- *          .sessionClientBuilder(sessionClientBuilder)
- *          .httpClientBuilder(ApacheHttpClient.builder().maxConnections(maxConnections))
- *          .build();
+ *     QldbDriver qldbDriver = QldbDriver
+ *         .builder()
+ *         .ledger(ledger)
+ *         .maxConcurrentTransactions(poolLimit)
+ *         .transactionRetryPolicy(TransactionRetryPolicy.builder().maxNumberOfRetries(retryLimit).build())
+ *         .sessionClientBuilder(sessionClientBuilder)
+ *         .httpClientBuilder(ApacheHttpClient.builder().maxConnections(maxConnections))
+ *         .build();
  * }</pre>
  *
  */