From 1c27127341aba6f5a96debc857949b02e93ae600 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 1 Jun 2023 20:57:52 +0000 Subject: [PATCH] Update docs --- docs/modules/api/examples/governance/MyGovernor.sol | 10 +++++----- docs/modules/api/examples/governance/MyToken.sol | 6 +++--- .../api/examples/governance/MyTokenTimestampBased.sol | 6 +++--- .../modules/api/examples/governance/MyTokenWrapped.sol | 8 ++++---- scripts/prepare-docs.sh | 2 +- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/modules/api/examples/governance/MyGovernor.sol b/docs/modules/api/examples/governance/MyGovernor.sol index 1656edc12..d7ec0ebe6 100644 --- a/docs/modules/api/examples/governance/MyGovernor.sol +++ b/docs/modules/api/examples/governance/MyGovernor.sol @@ -1,11 +1,11 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.2; -import "@openzeppelin/contracts/../governance/Governor.sol"; -import "@openzeppelin/contracts/../governance/compatibility/GovernorCompatibilityBravo.sol"; -import "@openzeppelin/contracts/../governance/extensions/GovernorVotes.sol"; -import "@openzeppelin/contracts/../governance/extensions/GovernorVotesQuorumFraction.sol"; -import "@openzeppelin/contracts/../governance/extensions/GovernorTimelockControl.sol"; +import "@openzeppelin/contracts/governance/Governor.sol"; +import "@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol"; +import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol"; +import "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol"; +import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol"; contract MyGovernor is Governor, diff --git a/docs/modules/api/examples/governance/MyToken.sol b/docs/modules/api/examples/governance/MyToken.sol index 4cdac2d21..8145043a1 100644 --- a/docs/modules/api/examples/governance/MyToken.sol +++ b/docs/modules/api/examples/governance/MyToken.sol @@ -1,9 +1,9 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.2; -import "@openzeppelin/contracts/../token/ERC20/ERC20.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol"; +import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol"; contract MyToken is ERC20, ERC20Permit, ERC20Votes { constructor() ERC20("MyToken", "MTK") ERC20Permit("MyToken") {} diff --git a/docs/modules/api/examples/governance/MyTokenTimestampBased.sol b/docs/modules/api/examples/governance/MyTokenTimestampBased.sol index 34893fab4..70f4d59af 100644 --- a/docs/modules/api/examples/governance/MyTokenTimestampBased.sol +++ b/docs/modules/api/examples/governance/MyTokenTimestampBased.sol @@ -1,9 +1,9 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.2; -import "@openzeppelin/contracts/../token/ERC20/ERC20.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol"; +import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol"; contract MyTokenTimestampBased is ERC20, ERC20Permit, ERC20Votes { constructor() ERC20("MyTokenTimestampBased", "MTK") ERC20Permit("MyTokenTimestampBased") {} diff --git a/docs/modules/api/examples/governance/MyTokenWrapped.sol b/docs/modules/api/examples/governance/MyTokenWrapped.sol index f9653c598..e1d75477a 100644 --- a/docs/modules/api/examples/governance/MyTokenWrapped.sol +++ b/docs/modules/api/examples/governance/MyTokenWrapped.sol @@ -1,10 +1,10 @@ // SPDX-License-Identifier: MIT pragma solidity ^0.8.2; -import "@openzeppelin/contracts/../token/ERC20/ERC20.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Permit.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Votes.sol"; -import "@openzeppelin/contracts/../token/ERC20/extensions/ERC20Wrapper.sol"; +import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol"; +import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Wrapper.sol"; contract MyTokenWrapped is ERC20, ERC20Permit, ERC20Votes, ERC20Wrapper { constructor( diff --git a/scripts/prepare-docs.sh b/scripts/prepare-docs.sh index 61772a5a6..d1317b092 100755 --- a/scripts/prepare-docs.sh +++ b/scripts/prepare-docs.sh @@ -20,7 +20,7 @@ examples_target_dir="docs/modules/api/examples" for f in "$examples_source_dir"/**/*.sol; do name="${f/#"$examples_source_dir/"/}" mkdir -p "$examples_target_dir/$(dirname "$name")" - sed -e '/^import/s|\.\./\.\./|@openzeppelin/contracts/|' "$f" > "$examples_target_dir/$name" + sed -Ee '/^import/s|"(\.\./)+|"@openzeppelin/contracts/|' "$f" > "$examples_target_dir/$name" done node scripts/gen-nav.js "$OUTDIR" > "$OUTDIR/../nav.adoc"