From c679dccb463cb0a4cb1021661c9cd15c87bcc1fd Mon Sep 17 00:00:00 2001 From: lvyaoting Date: Thu, 5 Dec 2024 23:48:57 +0800 Subject: [PATCH] chore: remove redundant words in comment Signed-off-by: lvyaoting --- CONTRIBUTING.md | 2 +- clarity/src/vm/docs/mod.rs | 2 +- clarity/src/vm/mod.rs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d6c3aabba..b8c63abc2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -579,7 +579,7 @@ _Do_ document things that are not clear, e.g.: Keep in mind that better variable names can reduce the need for comments, e.g.: - `burnblock_height` instead of `height` may eliminate the need to comment that `height` refers to a burnblock height -- `process_microblocks` instead of `process_blocks` is more correct, and may eliminate the need to to explain that the inputs are microblocks +- `process_microblocks` instead of `process_blocks` is more correct, and may eliminate the need to explain that the inputs are microblocks - `add_transaction_to_microblock` explains more than `handle_transaction`, and reduces the need to even read the comment # Licensing and contributor license agreement diff --git a/clarity/src/vm/docs/mod.rs b/clarity/src/vm/docs/mod.rs index 9075c55e71..b23e356dea 100644 --- a/clarity/src/vm/docs/mod.rs +++ b/clarity/src/vm/docs/mod.rs @@ -529,7 +529,7 @@ const LOG2_API: SimpleFunctionAPI = SimpleFunctionAPI { snippet: "log2 ${1:expr-1}", signature: "(log2 n)", description: - "Returns the power to which the number 2 must be raised to to obtain the value `n`, rounded + "Returns the power to which the number 2 must be raised to obtain the value `n`, rounded down to the nearest integer. Fails on a negative numbers. ", example: "(log2 u8) ;; Returns u3 diff --git a/clarity/src/vm/mod.rs b/clarity/src/vm/mod.rs index d64b207522..ff991f5513 100644 --- a/clarity/src/vm/mod.rs +++ b/clarity/src/vm/mod.rs @@ -575,7 +575,7 @@ pub fn execute(program: &str) -> Result> { ) } -/// Execute for test in in Clarity2, Epoch21, testnet. +/// Execute for test in Clarity2, Epoch21, testnet. #[cfg(any(test, feature = "testing"))] pub fn execute_v2(program: &str) -> Result> { execute_with_parameters(