Преглед на файлове

Fix docs links to overloaded functions (#2275)

* fix links to overloaded functions

* fix Address xrefs

Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>
Francisco Giordano преди 5 години
родител
ревизия
7f62c8e145
променени са 3 файла, в които са добавени 6 реда и са изтрити 6 реда
  1. 2 2
      contracts/utils/Address.sol
  2. 3 3
      docs/contract.hbs
  3. 1 1
      docs/prelude.hbs

+ 2 - 2
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._

+ 3 - 3
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}}

+ 1 - 1
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}}