From e20aded002a92218ec4e101c770158b66ad53274 Mon Sep 17 00:00:00 2001 From: Vectorized Date: Wed, 31 Jan 2024 14:30:35 +0000 Subject: [PATCH] Tidy natspec --- src/utils/LibString.sol | 4 ++-- src/utils/LibT.sol | 3 +++ src/utils/ReentrancyGuard.sol | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/src/utils/LibString.sol b/src/utils/LibString.sol index 5f5e504..a36e0ac 100644 --- a/src/utils/LibString.sol +++ b/src/utils/LibString.sol @@ -4,13 +4,13 @@ pragma solidity ^0.8.24; /// @notice Library for converting numbers into strings and other string operations. /// @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/LibString.sol) /// -/// Note: This implementation utilizes the `MCOPY` opcode. +/// @dev Note: This implementation utilizes the `MCOPY` opcode. /// Please ensure that the chain you are deploying on supports them. +/// /// For performance and bytecode compactness, most of the string operations are restricted to /// byte strings (7-bit ASCII), except where otherwise specified. /// Usage of byte string operations on charsets with runes spanning two or more bytes /// can lead to undefined behavior. - library LibString { /*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/ /* CUSTOM ERRORS */ diff --git a/src/utils/LibT.sol b/src/utils/LibT.sol index 6e294d9..1880606 100644 --- a/src/utils/LibT.sol +++ b/src/utils/LibT.sol @@ -3,6 +3,9 @@ pragma solidity ^0.8.24; /// @notice Transient storage helper. /// @author Soledge (https://github.com/vectorized/soledge/blob/main/src/utils/LibT.sol) +/// +/// @dev Note: This implementation utilizes the `MCOPY` opcode. +/// Please ensure that the chain you are deploying on supports them. library LibT { /// @dev Returns the value at `tSlot` in transient storage. function get(bytes32 tSlot) internal view returns (bytes32 result) { diff --git a/src/utils/ReentrancyGuard.sol b/src/utils/ReentrancyGuard.sol index 9b15e6c..48de118 100644 --- a/src/utils/ReentrancyGuard.sol +++ b/src/utils/ReentrancyGuard.sol @@ -4,7 +4,7 @@ pragma solidity ^0.8.24; /// @notice Reentrancy guard mixin. /// @author Soledge (https://github.com/vectorized/soledge/blob/main/src/utils/ReentrancyGuard.sol) /// -/// Note: This implementation utilizes the `TSTORE` and `TLOAD` opcodes. +/// @dev Note: This implementation utilizes the `TSTORE` and `TLOAD` opcodes. /// Please ensure that the chain you are deploying on supports them. abstract contract ReentrancyGuard { /*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/