Skip to content

Commit

Permalink
Tidy natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
Vectorized committed Jan 31, 2024
1 parent 749fdac commit e20aded
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
4 changes: 2 additions & 2 deletions src/utils/LibString.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 */
Expand Down
3 changes: 3 additions & 0 deletions src/utils/LibT.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion src/utils/ReentrancyGuard.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/
Expand Down

0 comments on commit e20aded

Please sign in to comment.