NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docs links to overloaded functions (#2275)

Browse Source 
* fix links to overloaded functions

* fix Address xrefs

Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>
This commit is contained in:
Francisco Giordano
2020-06-11 16:50:00 -03:00
committed by GitHub
parent e2876b947d
commit 7f62c8e145
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
contracts/utils/Address.sol
View File

@ -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. * `errorMessage` as a fallback revert reason when `target` reverts.
* *
* _Available since v3.1._ * _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. * with `errorMessage` as a fallback revert reason when `target` reverts.
* *
* _Available since v3.1._ * _Available since v3.1._

6
docs/contract.hbs
View File

@ -22,7 +22,7 @@
.{{contract.name}} .{{contract.name}}
{{/unless}} {{/unless}}
{{#each modifiers}} {{#each modifiers}}
* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] * {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`]
{{/each}} {{/each}}
{{/each}} {{/each}}
@ -39,7 +39,7 @@
.{{contract.name}} .{{contract.name}}
{{/unless}} {{/unless}}
{{#each functions}} {{#each functions}}
* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] * {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`]
{{/each}} {{/each}}
{{/each}} {{/each}}
@ -56,7 +56,7 @@
.{{contract.name}} .{{contract.name}}
{{/unless}} {{/unless}}
{{#each events}} {{#each events}}
* {xref-{{slug fullName~}} }[`++{{name}}({{args.names}})++`] * {xref-{{slug anchor~}} }[`++{{name}}({{args.names}})++`]
{{/each}} {{/each}}
{{/each}} {{/each}}

2
docs/prelude.hbs
View File

@ -1,4 +1,4 @@
{{#links}} {{#links}}
:{{slug target.fullName}}: pass:normal[xref:{{path}}#{{target.anchor}}[`{{target.fullName}}`]] :{{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}} {{/links}}