From 7f62c8e14538542023c60ea1caf38b36f2d7c746 Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Thu, 11 Jun 2020 16:50:00 -0300 Subject: [PATCH] Fix docs links to overloaded functions (#2275) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix links to overloaded functions * fix Address xrefs Co-authored-by: Nicolás Venturo --- contracts/utils/Address.sol | 4 ++-- docs/contract.hbs | 6 +++--- docs/prelude.hbs | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/contracts/utils/Address.sol b/contracts/utils/Address.sol index 8c8359669..cf445ccf7 100644 --- a/contracts/utils/Address.sol +++ b/contracts/utils/Address.sol @@ -78,7 +78,7 @@ library Address { } /** - * @dev Same as {Address-functionCall-address-bytes-}, but with + * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ @@ -108,7 +108,7 @@ library Address { } /** - * @dev Same as {Address-functionCallWithValue-address-bytes-uint256-}, but + * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ diff --git a/docs/contract.hbs b/docs/contract.hbs index 632289511..0237a0b7c 100644 --- a/docs/contract.hbs +++ b/docs/contract.hbs @@ -22,7 +22,7 @@ .{{contract.name}} {{/unless}} {{#each modifiers}} -* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] +* {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`] {{/each}} {{/each}} @@ -39,7 +39,7 @@ .{{contract.name}} {{/unless}} {{#each functions}} -* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] +* {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`] {{/each}} {{/each}} @@ -56,7 +56,7 @@ .{{contract.name}} {{/unless}} {{#each events}} -* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] +* {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`] {{/each}} {{/each}} diff --git a/docs/prelude.hbs b/docs/prelude.hbs index 5c2271b1d..6f5624b83 100644 --- a/docs/prelude.hbs +++ b/docs/prelude.hbs @@ -1,4 +1,4 @@ {{#links}} :{{slug target.fullName}}: pass:normal[xref:{{path}}#{{target.anchor}}[`{{target.fullName}}`]] -:xref-{{slug target.fullName}}: xref:{{path}}#{{target.anchor}} +:xref-{{slug target.anchor}}: xref:{{path}}#{{target.anchor}} {{/links}}