Skip to content

Commit

Permalink
docs: polish natspec in Protocol.s.sol
Browse files Browse the repository at this point in the history
  • Loading branch information
andreivladbrg committed Aug 22, 2024
1 parent 6697736 commit f38fe51
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions script/protocol/Protocol.s.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ import { stdJson } from "forge-std/src/StdJson.sol";

import { BaseScript } from "../Base.s.sol";

/// @dev This contract creates a Markdown file with the deployed addresses with the format used in docs:
/// https://docs.sablier.com/contracts/v2/deployments
/// @dev This contract appends to a Markdown file, which is assumed to be already created at the `deploymentFile` path,
/// with the deployed addresses in the format used in the docs: https://docs.sablier.com/contracts/v2/deployments.
/// This script is intended to be used in `deploy-multi-chain/src/main.rs`.
abstract contract ProtocolScript is BaseScript {
using stdJson for string;
using Strings for address;
Expand Down Expand Up @@ -199,6 +200,7 @@ abstract contract ProtocolScript is BaseScript {
vm.writeLine({ path: deploymentFile, data: line });
}

/// @dev Returns a string for a single contract line formatted according to the docs.
function _getContractLine(
string memory contractName,
string memory contractAddress,
Expand Down

0 comments on commit f38fe51

Please sign in to comment.