Documentation cleanup steemit#2458

ob1Shaun · Oct 23, 2018 · 3b1cc63 · 3b1cc63
1 parent 6a6d3c2
commit 3b1cc63
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 9 deletions.
diff --git a/libraries/plugins/apis/transaction_status_api/transaction_status_api.cpp b/libraries/plugins/apis/transaction_status_api/transaction_status_api.cpp
@@ -60,7 +60,7 @@ DEFINE_API_IMPL( transaction_status_api_impl, find_transaction )
       {
          const auto& expiration = *args.expiration;
 
-         // Check if the expiration is before our earliest tracked block
+         // Check if the expiration is before our earliest tracked block plus maximum transaction expiration
          auto earliest_tracked_block = _db.fetch_block_by_number( earliest_tracked_block_num );
          if ( expiration < earliest_tracked_block->timestamp + STEEM_MAX_TIME_UNTIL_EXPIRATION )
             return {

diff --git a/libraries/plugins/transaction_status/transaction_status_plugin.cpp b/libraries/plugins/transaction_status/transaction_status_plugin.cpp
@@ -18,21 +18,19 @@
  *                             window of uncertainty              trackable
  *                          .-------------------------. .---------------------------.
  *                         |                           |                             |
- * <- - - - - - - - - - - [*] - - - - - - - - - - - - [*] - - - - - - - - - - - - - [*]
+ *   <- - - - - - - - - - [*] - - - - - - - - - - - - [*] - - - - - - - - - - - - - [*]
  *                        /                            |                              \
  *               actual block depth            nominal block depth                head block
  *
- * Notes:
- *
- * > Within the window of uncertainy, if the transaction is found we will return the status
+ * - Within the window of uncertainy, if the transaction is found we will return the status
  *      If the transaction is not found and an expiration is provided, we will return `too_old`
  *
- * > Within the trackable range, if the transaction is found we will return the status
+ * - Within the trackable range, if the transaction is found we will return the status
  *      If the transaction is not found and an expiration is provided we will return the expiration status
  *
- * > Nominal values are values provided by the user
+ * - Nominal values are values provided by the user
  *
- * > Actual values are calculated and used to determine when tracking needs to begin
+ * - Actual values are calculated and used to determine when tracking needs to begin
  *      see `plugin_initialize`
  */
 

diff --git a/tests/plugin_tests/transaction_status.cpp b/tests/plugin_tests/transaction_status.cpp
@@ -210,7 +210,7 @@ BOOST_AUTO_TEST_CASE( transaction_status_functionality_test )
 
       generate_blocks( TRANSACTION_STATUS_TEST_BLOCK_DEPTH );
 
-      // Transaction 1 is tracked
+      // Transaction 1 exists in a block
       tso = db->find< transaction_status_object, by_trx_id >( tx1.id() );
       BOOST_REQUIRE( tso != nullptr );
       BOOST_REQUIRE( tso->block_num > 0 );