From 338cd0d3a1c99cb29e4e8598a86979d326226bb0 Mon Sep 17 00:00:00 2001
From: Ryoji Kurosawa <kurosawa@nautilus-technologies.com>
Date: Tue, 25 Feb 2025 18:15:44 +0900
Subject: [PATCH 1/3] docs: description on invalid scan range

---
 include/kvs.h | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

diff --git a/include/kvs.h b/include/kvs.h
index 8f84408..60bf57f 100644
--- a/include/kvs.h
+++ b/include/kvs.h
@@ -230,14 +230,18 @@ put(Token token, std::string_view storage_name, // NOLINT
  * @param[in] l_end If this argument is scan_endpoint::EXCLUSIVE, the interval
  * does not include the endpoint. If this argument is scan_endpoint::INCLUSIVE,
  * the interval contains the endpoint. If this is scan_endpoint::INF, there is
- * no limit on the interval in left direction. And ignore @a l_key.
+ * no limit on the interval in left direction.
  * @param[in] r_key An argument that specifies the right endpoint.
- * @note If r_key <l_key is specified in dictionary order, nothing will be hit.
- * @param[in] r_end If this argument is scan_endpoint :: EXCLUSIVE, the
- * interval does not include the endpoint. If this argument is
- * scan_endpoint::INCLUSIVE, the interval contains the endpoint. If this is
- * scan_endpoint::INF, there is no limit on the interval in right direction.
- * And ignore @a r_key.
+ * @param[in] r_end If this argument is scan_endpoint::EXCLUSIVE, the interval
+ * does not include the endpoint. If this argument is scan_endpoint::INCLUSIVE,
+ * the interval contains the endpoint. If this is scan_endpoint::INF, there is
+ * no limit on the interval in right direction.
+ * @note The interval defined by `l_key`, `l_end`, `r_key`, and `r_end` must represent a valid range
+ * and otherwise an error (Status::ERR_BAD_USAGE) will be returned. A range is invalid if any of the following
+ * conditions are satisfied.
+ * - `r_key` < `l_key` and neither `l_end` nor `r_end` is scan_endpoint::INF
+ * - `l_key` equals to `r_key` and either `l_end` or `r_end` is scan_endpoint::EXCLUSIVE
+ k - `r_key` is empty string and `r_end` is scan_endpoint::EXCLUSIVE
  * @param[out] tuple_list A set with a key, a pointer to value, and size of
  * value as a result of this function.
  * The address obtained here can be accessed safely until the Token entered at the time of address acquisition leaves.
@@ -253,17 +257,16 @@ put(Token token, std::string_view storage_name, // NOLINT
  * node_version_vec to guarantee atomicity, you can split the atomic scan.
  * Suppose you want to scan with A: C, assuming the order A <B <C. You can
  * perform an atomic scan by scanning the range A: B, B: C and using
- * node_version_vec to make sure the values ​​are not overwritten. This advantage
+ * node_version_vec to make sure the values are not overwritten. This advantage
  * is effective when the right end point is unknown but you want to scan to a
  * specific value.
  * @param[in] right_to_left If this argument is true, the scan is performed from right end.
  * When this is set to true, current implementation has following limitation: 1. max_size must be 1 so that at most
  * one entry is hit and returned as scan result 2. r_end must be scan_endpoint::INF so that the scan is performed from
  * unbounded right end. Status::ERR_BAD_USAGE is returned if these conditions are not met.
- * @return Status::ERR_BAD_USAGE The arguments is invalid. In the case1: you use
- * same l_key and r_key and one of the endpoint is exclusive. case2: one of the
- * endpoint use null key but the string size is not zero like
- * std::string_view{nullptr, non-zero-value}.
+ * @return Status::ERR_BAD_USAGE The input argument or the range given by the arguments are invalid (see note above.)
+ * This includes the case where one of the endpoints uses scan_endpoint::INF and the corresponding key is not null
+ * (i.e. different from default constructed std::string_view.)
  * @return status::OK success.
  * @return Status::OK_ROOT_IS_NULL success and root is null.
  * @return status::WARN_STORAGE_NOT_EXIST The target storage of this operation

From ed37c57d6d84d43348b054a0a69cdb4e07c2f83a Mon Sep 17 00:00:00 2001
From: Ryoji Kurosawa <kurosawa@nautilus-technologies.com>
Date: Wed, 26 Feb 2025 07:57:45 +0900
Subject: [PATCH 2/3] fix a typo

---
 include/kvs.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/kvs.h b/include/kvs.h
index 60bf57f..e5f85b6 100644
--- a/include/kvs.h
+++ b/include/kvs.h
@@ -241,7 +241,7 @@ put(Token token, std::string_view storage_name, // NOLINT
  * conditions are satisfied.
  * - `r_key` < `l_key` and neither `l_end` nor `r_end` is scan_endpoint::INF
  * - `l_key` equals to `r_key` and either `l_end` or `r_end` is scan_endpoint::EXCLUSIVE
- k - `r_key` is empty string and `r_end` is scan_endpoint::EXCLUSIVE
+ * - `r_key` is empty string and `r_end` is scan_endpoint::EXCLUSIVE
  * @param[out] tuple_list A set with a key, a pointer to value, and size of
  * value as a result of this function.
  * The address obtained here can be accessed safely until the Token entered at the time of address acquisition leaves.

From 838c8be37967dbc34917eed98c1fe04c1520f245 Mon Sep 17 00:00:00 2001
From: Ryoji Kurosawa <kurosawa@nautilus-technologies.com>
Date: Wed, 26 Feb 2025 10:05:59 +0900
Subject: [PATCH 3/3] fix api doc handling INF

---
 include/kvs.h | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/include/kvs.h b/include/kvs.h
index e5f85b6..d29492e 100644
--- a/include/kvs.h
+++ b/include/kvs.h
@@ -230,17 +230,18 @@ put(Token token, std::string_view storage_name, // NOLINT
  * @param[in] l_end If this argument is scan_endpoint::EXCLUSIVE, the interval
  * does not include the endpoint. If this argument is scan_endpoint::INCLUSIVE,
  * the interval contains the endpoint. If this is scan_endpoint::INF, there is
- * no limit on the interval in left direction.
+ * no limit on the interval in left direction and `l_key` is ignored.
  * @param[in] r_key An argument that specifies the right endpoint.
  * @param[in] r_end If this argument is scan_endpoint::EXCLUSIVE, the interval
  * does not include the endpoint. If this argument is scan_endpoint::INCLUSIVE,
  * the interval contains the endpoint. If this is scan_endpoint::INF, there is
- * no limit on the interval in right direction.
+ * no limit on the interval in right direction and `r_key` is ignored.
  * @note The interval defined by `l_key`, `l_end`, `r_key`, and `r_end` must represent a valid range
  * and otherwise an error (Status::ERR_BAD_USAGE) will be returned. A range is invalid if any of the following
  * conditions are satisfied.
- * - `r_key` < `l_key` and neither `l_end` nor `r_end` is scan_endpoint::INF
- * - `l_key` equals to `r_key` and either `l_end` or `r_end` is scan_endpoint::EXCLUSIVE
+ * - neither `l_end` nor `r_end` is scan_endpoint::INF and `r_key` < `l_key`
+ * - neither `l_end` nor `r_end` is scan_endpoint::INF and `l_key` == `r_key` and either `l_end` or `r_end`
+ * is scan_endpoint::EXCLUSIVE
  * - `r_key` is empty string and `r_end` is scan_endpoint::EXCLUSIVE
  * @param[out] tuple_list A set with a key, a pointer to value, and size of
  * value as a result of this function.
@@ -264,9 +265,7 @@ put(Token token, std::string_view storage_name, // NOLINT
  * When this is set to true, current implementation has following limitation: 1. max_size must be 1 so that at most
  * one entry is hit and returned as scan result 2. r_end must be scan_endpoint::INF so that the scan is performed from
  * unbounded right end. Status::ERR_BAD_USAGE is returned if these conditions are not met.
- * @return Status::ERR_BAD_USAGE The input argument or the range given by the arguments are invalid (see note above.)
- * This includes the case where one of the endpoints uses scan_endpoint::INF and the corresponding key is not null
- * (i.e. different from default constructed std::string_view.)
+ * @return Status::ERR_BAD_USAGE The input argument or the range given by the arguments is invalid (see note above.)
  * @return status::OK success.
  * @return Status::OK_ROOT_IS_NULL success and root is null.
  * @return status::WARN_STORAGE_NOT_EXIST The target storage of this operation