Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Grammar and Clarity Improvements in Code Comments (#258)
### 1. File: `src/tracing/mux.rs` - **Old:** `/// A instance of FourByteInspector that can be reused` - **New:** `/// An instance of FourByteInspector that can be reused` - **Reason:** Corrected the grammatical error by changing "A" to "An" to ensure proper article usage before a vowel sound. ### 2. File: `src/tracing/utils.rs` - **Old:** `/// Returns a non empty revert reason if the output is a revert/error.` - **New:** `/// Returns a non-empty revert reason if the output is a revert/error.` - **Reason:** Added a hyphen to "non-empty" to correctly form the compound adjective, improving clarity and grammatical accuracy. ### 3. File: `src/transfer.rs` - **Old:** `/// A non zero value transfer CALL` - **New:** `/// A non-zero value transfer CALL` - **Reason:** Added a hyphen to "non-zero" to correctly form the compound adjective, enhancing clarity and grammatical correctness. ## Summary These changes improve the grammatical accuracy and clarity of the comments in the code, ensuring that the documentation is professional and easy to understand. Proper use of articles and hyphenation in compound adjectives is essential for maintaining high-quality code documentation.
- Loading branch information