ci: generate v2 docs using forge doc #334
Conversation
fadeev
requested review from
andresaiello,
brewmaster012,
lumtis,
CharlieMc0,
skosito and
fbac
as code owners
WalkthroughWalkthroughThe recent changes include updates to documentation and workflow files, enhancing structure and clarity. A new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Contract
participant Gateway
participant TSS
User->>Contract: Deposit Tokens
Contract->>Gateway: Forward Deposit Request
Gateway->>TSS: Validate Transaction
TSS-->>Gateway: Confirmation
Gateway->>Contract: Process Deposit
Contract-->>User: Confirmation of Deposit
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #334 +/- ##
=======================================
Coverage 82.35% 82.35%
=======================================
Files 7 7
Lines 306 306
Branches 99 99
=======================================
Hits 252 252
Misses 54 54 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (45)
v2/docs/src/contracts/Revert.sol/interface.Revertable.md (1)
16-16: Use a heading instead of emphasis for "Parameters".Markdownlint suggests using a heading for better structure.
-**Parameters** +## ParametersTools
Markdownlint
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/Revert.sol/struct.RevertContext.md (1)
15-15: Use a heading instead of emphasis for "Properties".Markdownlint suggests using a heading for better structure.
-**Properties** +## PropertiesTools
Markdownlint
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md (1)
17-17: Use a heading instead of emphasis for "Properties".Markdownlint suggests using a heading for better structure.
-**Properties** +## PropertiesTools
Markdownlint
17-17: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md (1)
4-4: Use a heading instead of emphasis for "Custom errors for ZRC20".Markdownlint suggests using a heading for better structure.
-*Custom errors for ZRC20* +## Custom errors for ZRC20Tools
Markdownlint
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/README.md (1)
10-10: Remove dollar signs from shell command examples.Markdownlint suggests removing dollar signs before shell commands to avoid confusion, as they are not necessary for showing command output.
- $ forge build + forge build - $ forge test + forge test - $ forge fmt + forge fmt - $ forge snapshot + forge snapshot - $ anvil + anvil - $ forge script script/<DeployScript>.s.sol:<DeployScript> --rpc-url <your_rpc_url> --private-key <your_private_key> + forge script script/<DeployScript>.s.sol:<DeployScript> --rpc-url <your_rpc_url> --private-key <your_private_key> - $ cast <subcommand> + cast <subcommand> - $ forge --help - $ anvil --help - $ cast --help + forge --help + anvil --help + cast --helpAlso applies to: 16-16, 22-22, 28-28, 34-34, 40-40, 46-46, 52-54
Tools
Markdownlint
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md (1)
13-13: Use "number of" for countable nouns.Consider using "number of" instead of "amount of" for countable nouns like tokens.
- Burns the specified amount of tokens from the specified account. + Burns the specified number of tokens from the specified account. - The amount of tokens to burn. + The number of tokens to burn. - Mints the specified amount of tokens to the specified account. + Mints the specified number of tokens to the specified account. - The amount of tokens to mint. + The number of tokens to mint.Also applies to: 26-26, 31-31, 44-44
Tools
LanguageTool
[uncategorized] ~13-~13: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...tions ### burnFrom Burns the specified amount of tokens from the specified account. ...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md (2)
16-16: Use headings instead of emphasis.Consider using proper headings for the "Parameters" sections instead of emphasis to improve readability and follow Markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 31-31, 47-47
Tools
Markdownlint
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
21-21: Consider using "number" instead of "amount".The term "amount" is typically used with uncountable nouns. Consider using "number" for countable items like tokens.
- The amount of tokens withdrawn. + The number of tokens withdrawn.Also applies to: 36-36, 52-52
Tools
LanguageTool
[uncategorized] ~21-~21: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...are withdrawn.| |amount|uint256|The amount of tokens withdrawn.| ### WithdrawnAnd...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md (2)
23-23: Use headings instead of emphasis.Consider using proper headings for the "Parameters" sections instead of emphasis to improve readability and follow Markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 53-53
Tools
Markdownlint
23-23: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
61-61: Consider using "number" instead of "amount".The term "amount" is typically used with uncountable nouns. Consider using "number" for countable items like tokens.
- The amount of tokens withdrawn. + The number of tokens withdrawn.Tools
LanguageTool
[uncategorized] ~61-~61: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...he ZRC20 token.| |value|uint256|The amount of tokens withdrawn.| |gasfee|`uint25...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md (1)
87-87: Use headings instead of emphasis.Consider using proper headings for the notes about uppercase names to improve readability and follow Markdown best practices.
- *Name is in upper case to maintain compatibility with ZRC20.sol v1* + ## Note + Name is in upper case to maintain compatibility with ZRC20.sol v1Also applies to: 96-96
Tools
Markdownlint
87-87: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md (3)
34-34: Consider using "number" instead of "amount".The phrase "Amount of tokens" should be replaced with "Number of tokens" for better clarity, as "amount" is typically used with uncountable nouns.
- |`amount`|`uint256`|Amount of tokens to withdraw.| + |`amount`|`uint256`|Number of tokens to withdraw.|Also applies to: 53-53, 81-81
Tools
LanguageTool
[uncategorized] ~34-~34: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ss for the tokens.| |amount|uint256|Amount of tokens to withdraw.| ### withdrawA...(AMOUNTOF_TO_NUMBEROF)
59-59: Add the missing article "the".The sentence "WithdrawAndRevert transfers tokens to Gateway and call a contract with a revert functionality through the Gateway." is missing the article "the" before "Gateway".
- WithdrawAndRevert transfers tokens to Gateway and call a contract with a revert functionality through + WithdrawAndRevert transfers tokens to the Gateway and calls a contract with a revert functionality throughTools
LanguageTool
[uncategorized] ~59-~59: You might be missing the article “the” here.
Context: ... WithdrawAndRevert transfers tokens to Gateway and call a contract with a revert funct...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~59-~59: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...dRevert transfers tokens to Gateway and call a contract with a revert functionality ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
28-28: Use headings instead of emphasis for parameter sections.The emphasis used for "Parameters" should be replaced with a heading to improve readability and adhere to markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 47-47, 75-75
Tools
Markdownlint
28-28: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md (2)
22-22: Consider using "number" instead of "amount".The phrase "Amount of tokens" should be replaced with "Number of tokens" for better clarity, as "amount" is typically used with uncountable nouns.
- |`amount`|`uint256`|The amount of tokens withdrawn.| + |`amount`|`uint256`|The number of tokens withdrawn.|Also applies to: 38-38, 57-57
Tools
LanguageTool
[uncategorized] ~22-~22: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ERC20 token.| |amount|uint256|The amount of tokens withdrawn.| ### WithdrawnAnd...(AMOUNTOF_TO_NUMBEROF)
16-16: Use headings instead of emphasis for parameter sections.The emphasis used for "Parameters" should be replaced with a heading to improve readability and adhere to markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 32-32, 51-51, 69-69, 83-83
Tools
Markdownlint
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/SUMMARY.md (1)
4-38: Fix unordered list indentation.The indentation of the unordered list items is inconsistent. Proper indentation is crucial for maintaining the hierarchical structure of the summary.
- - [❱ evm](contracts/evm/README.md) - - [❱ interfaces](contracts/evm/interfaces/README.md) - - [IERC20CustodyEvents](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md) - - [IERC20CustodyErrors](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md) - - [IERC20Custody](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md) - - [IGatewayEVMEvents](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md) - - [IGatewayEVMErrors](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md) - - [IGatewayEVM](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md) - - [IZetaConnectorEvents](contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md) - - [IZetaNonEthNew](contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md) - - [ERC20Custody](contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md) - - [GatewayEVM](contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md) - - [ZetaConnectorBase](contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md) - - [ZetaConnectorNative](contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md) - - [ZetaConnectorNonNative](contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md) - - [❱ zevm](contracts/zevm/README.md) - - [❱ interfaces](contracts/zevm/interfaces/README.md) - - [IGatewayZEVMEvents](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md) - - [IGatewayZEVMErrors](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md) - - [IGatewayZEVM](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md) - - [ISystem](contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md) - - [IWETH9](contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md) - - [IZRC20](contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md) - - [IZRC20Metadata](contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md) - - [ZRC20Events](contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md) - - [CoinType](contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md) - - [zContext](contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md) - - [zContract](contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md) - - [UniversalContract](contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md) - - [GatewayZEVM](contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md) - - [ZRC20Errors](contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md) - - [ZRC20](contracts/zevm/ZRC20.sol/contract.ZRC20.md) - - [RevertOptions](contracts/Revert.sol/struct.RevertOptions.md) - - [RevertContext](contracts/Revert.sol/struct.RevertContext.md) - - [Revertable](contracts/Revert.sol/interface.Revertable.md) + - [❱ evm](contracts/evm/README.md) + - [❱ interfaces](contracts/evm/interfaces/README.md) + - [IERC20CustodyEvents](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md) + - [IERC20CustodyErrors](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md) + - [IERC20Custody](contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md) + - [IGatewayEVMEvents](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md) + - [IGatewayEVMErrors](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md) + - [IGatewayEVM](contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md) + - [IZetaConnectorEvents](contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md) + - [IZetaNonEthNew](contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md) + - [ERC20Custody](contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md) + - [GatewayEVM](contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md) + - [ZetaConnectorBase](contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md) + - [ZetaConnectorNative](contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md) + - [ZetaConnectorNonNative](contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md) + - [❱ zevm](contracts/zevm/README.md) + - [❱ interfaces](contracts/zevm/interfaces/README.md) + - [IGatewayZEVMEvents](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md) + - [IGatewayZEVMErrors](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md) + - [IGatewayZEVM](contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md) + - [ISystem](contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md) + - [IWETH9](contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md) + - [IZRC20](contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md) + - [IZRC20Metadata](contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md) + - [ZRC20Events](contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md) + - [CoinType](contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md) + - [zContext](contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md) + - [zContract](contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md) + - [UniversalContract](contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md) + - [GatewayZEVM](contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md) + - [ZRC20Errors](contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md) + - [ZRC20](contracts/zevm/ZRC20.sol/contract.ZRC20.md) + - [RevertOptions](contracts/Revert.sol/struct.RevertOptions.md) + - [RevertContext](contracts/Revert.sol/struct.RevertContext.md) + - [Revertable](contracts/Revert.sol/interface.Revertable.md)Tools
Markdownlint
4-4: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
5-5: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
6-6: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
7-7: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
8-8: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
9-9: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
10-10: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
12-12: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
13-13: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
18-18: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
23-23: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
24-24: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
25-25: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
26-26: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
27-27: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
28-28: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
29-29: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
30-30: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
31-31: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
32-32: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
33-33: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
34-34: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-35: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
37-37: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
38-38: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md (2)
56-56: Consider using "number" instead of "amount".The phrase "Amount of tokens" should be replaced with "Number of tokens" for better clarity, as "amount" is typically used with uncountable nouns.
- |`amount`|`uint256`|The amount of tokens transferred.| + |`amount`|`uint256`|The number of tokens transferred.|Tools
LanguageTool
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ntract called.| |amount|uint256|The amount of tokens transferred.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
16-16: Use headings instead of emphasis for parameter sections.The emphasis used for "Parameters" should be replaced with a heading to improve readability and adhere to markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 32-32, 50-50, 74-74, 93-93
Tools
Markdownlint
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md (2)
50-50: Consider using "number" instead of "amount".The phrase "Amount of tokens" should be replaced with "Number of tokens" for better clarity, as "amount" is typically used with uncountable nouns.
- |`amount`|`uint256`|The amount of tokens to withdraw.| + |`amount`|`uint256`|The number of tokens to withdraw.|Also applies to: 79-79, 110-110, 128-128
Tools
LanguageTool
[uncategorized] ~50-~50: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
45-45: Use headings instead of emphasis for parameter sections.The emphasis used for "Parameters" should be replaced with a heading to improve readability and adhere to markdown best practices.
- **Parameters** + ## ParametersAlso applies to: 74-74, 105-105, 124-124
Tools
Markdownlint
45-45: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md (2)
101-101: Use "number" instead of "amount" for countable nouns.In technical documentation, "number" is preferred over "amount" when referring to countable items like tokens.
- |`amount`|`uint256`|The amount of tokens to withdraw.| + |`amount`|`uint256`|The number of tokens to withdraw.|Also applies to: 118-118, 144-144, 162-162
Tools
LanguageTool
[uncategorized] ~101-~101: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
96-96: Use headings instead of emphasis.Markdownlint suggests using proper headings instead of emphasis for parameter sections.
- **Parameters** + #### ParametersAlso applies to: 113-113, 139-139, 158-158
Tools
Markdownlint
96-96: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/index.md (2)
63-97: Correct list indentation for consistency.The list indentation is inconsistent. Ensure that each level of the list is indented correctly for better readability.
- - [❱ evm](protocol/contracts/evm/README.md) - - [❱ interfaces](protocol/contracts/evm/interfaces/README.md) - - [IERC20CustodyEvents](protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md) + - [❱ evm](protocol/contracts/evm/README.md) + - [❱ interfaces](protocol/contracts/evm/interfaces/README.md) + - [IERC20CustodyEvents](protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md)Tools
Markdownlint
63-63: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
64-64: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
65-65: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
66-66: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
67-67: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
68-68: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
69-69: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
70-70: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
71-71: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
72-72: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
73-73: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
74-74: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
75-75: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
76-76: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
77-77: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
78-78: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
79-79: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
80-80: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
81-81: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
82-82: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
83-83: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
84-84: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
85-85: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
87-87: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
88-88: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
89-89: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
90-90: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
91-91: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
92-92: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
93-93: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
94-94: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
95-95: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
96-96: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
97-97: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
14-14: Avoid using dollar signs before commands without showing output.Remove dollar signs from commands unless showing expected output to align with Markdownlint guidelines.
- $ forge build + forge buildAlso applies to: 20-20, 26-26, 32-32, 38-38, 44-44, 50-50, 56-58
Tools
Markdownlint
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md (2)
77-77: Use "number" instead of "amount" for countable nouns.In technical documentation, "number" is preferred over "amount" when referring to countable items like tokens.
- |`amount`|`uint256`|The amount of tokens to withdraw.| + |`amount`|`uint256`|The number of tokens to withdraw.|Also applies to: 106-106, 137-137, 155-155
Tools
LanguageTool
[uncategorized] ~77-~77: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
46-46: Use headings instead of emphasis.Markdownlint suggests using proper headings instead of emphasis for parameter sections.
- **Parameters** + #### ParametersAlso applies to: 72-72, 101-101, 132-132, 151-151, 160-160, 176-176
Tools
Markdownlint
46-46: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md (2)
25-25: Use "number" instead of "amount" for countable nouns.In technical documentation, "number" is preferred over "amount" when referring to countable items like tokens.
- |`amount`|`uint256`|The amount of tokens to transfer.| + |`amount`|`uint256`|The number of tokens to transfer.|Also applies to: 97-97, 131-131, 179-179
Tools
LanguageTool
[uncategorized] ~25-~25: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...tract to call.| |amount|uint256|The amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
19-19: Use headings instead of emphasis.Markdownlint suggests using proper headings instead of emphasis for parameter sections.
- **Parameters** + #### ParametersAlso applies to: 45-45, 62-62, 69-69, 91-91, 110-110, 126-126, 150-150, 174-174, 193-193
Tools
Markdownlint
19-19: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md (3)
41-41: Correct the abbreviation "eg." to "e.g.".The abbreviation for "for example" should be "e.g." with periods.
- (eg. deposit). + (e.g., deposit).Tools
LanguageTool
[uncategorized] ~41-~41: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ag if contract supports legacy methods (eg. deposit). ```solidity bool public sup...(E_G)
169-169: Use "number" instead of "amount" for countable nouns.In technical documentation, "number" is preferred over "amount" when referring to countable items like tokens.
- |`amount`|`uint256`|Amount of tokens to withdraw.| + |`amount`|`uint256`|Number of tokens to withdraw.|Also applies to: 197-197, 228-228
Tools
LanguageTool
[uncategorized] ~169-~169: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to withdraw.| ### withdrawA...(AMOUNTOF_TO_NUMBEROF)
123-123: Use headings instead of emphasis.Markdownlint suggests using proper headings instead of emphasis for parameter sections.
- **Parameters** + #### ParametersAlso applies to: 138-138, 163-163, 191-191, 222-222
Tools
Markdownlint
123-123: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md (3)
32-32: Consider using "number" instead of "amount".For better clarity, especially in technical documentation, consider using "number of tokens" instead of "amount of tokens" as suggested by the LanguageTool.
- The amount of tokens to withdraw. + The number of tokens to withdraw.Also applies to: 56-56, 82-82, 109-109, 154-154, 179-179, 205-205, 223-223, 263-263
Tools
LanguageTool
[uncategorized] ~32-~32: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
37-37: Avoid duplicate headings.The headings for functions are duplicated. Consider renaming them to avoid confusion.
- ### withdraw + ### withdrawZETAAlso applies to: 89-89, 210-210
Tools
Markdownlint
37-37: null
Multiple headings with the same content(MD024, no-duplicate-heading)
27-27: Use headings instead of emphasis for section titles.Replace emphasis with proper markdown headings for better readability and structure.
- **Parameters** + ## ParametersAlso applies to: 51-51, 77-77, 104-104, 130-130, 149-149, 173-173, 199-199, 218-218, 236-236, 258-258
Tools
Markdownlint
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md (3)
347-347: Consider using "number" instead of "amount".For better clarity, especially in technical documentation, consider using "number of tokens" instead of "amount of tokens" as suggested by the LanguageTool.
- Burns an amount of tokens. + Burns a number of tokens.Tools
LanguageTool
[uncategorized] ~347-~347: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ucceeded/failed.| ### burn Burns an amount of tokens. ```solidity function burn...(AMOUNTOF_TO_NUMBEROF)
474-474: Ensure completeness of sentences.To form complete sentences, include a subject. This improves clarity and professionalism in documentation.
- Updates system contract address. Can only be updated by the fungible module. + The system contract address can be updated. Only the fungible module can perform this update.Also applies to: 489-489, 504-504, 519-519
Tools
LanguageTool
[style] ~474-~474: To form a complete sentence, be sure to include a subject.
Context: ...ress *Updates system contract address. Can only be updated by the fungible module....(MISSING_IT_THERE)
39-39: Use headings instead of emphasis for section titles.Replace emphasis with proper markdown headings for better readability and structure.
- **Parameters** + ## ParametersAlso applies to: 50-50, 61-61, 114-114, 159-159, 165-165, 198-198, 213-213, 228-228, 243-243, 249-249, 264-264, 271-271, 286-286, 293-293, 308-308, 315-315, 330-330, 338-338, 353-353, 359-359, 402-402, 409-409, 424-424, 434-434, 440-440, 458-458, 465-465, 480-480, 495-495, 510-510, 525-525
Tools
Markdownlint
39-39: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md (3)
122-122: Consider using "number" instead of "amount".For better clarity, especially in technical documentation, consider using "number of tokens" instead of "amount of tokens" as suggested by the LanguageTool.
- The amount of tokens to withdraw. + The number of tokens to withdraw.Also applies to: 144-144, 167-167, 192-192, 220-220, 248-248, 275-275, 322-322, 349-349, 377-377, 403-403, 445-445
Tools
LanguageTool
[uncategorized] ~122-~122: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
227-227: Avoid duplicate headings.The headings for functions are duplicated. Consider renaming them to avoid confusion.
- ### withdraw + ### withdrawZETAAlso applies to: 253-253, 382-382
Tools
Markdownlint
227-227: null
Multiple headings with the same content(MD024, no-duplicate-heading)
76-76: Use headings instead of emphasis for section titles.Replace emphasis with proper markdown headings for better readability and structure.
- **Parameters** + ## ParametersAlso applies to: 118-118, 125-125, 140-140, 148-148, 163-163, 187-187, 215-215, 243-243, 270-270, 298-298, 317-317, 343-343, 371-371, 398-398, 416-416, 440-440
Tools
Markdownlint
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md (4)
237-237: Consider using "number" instead of "amount".For better clarity, especially in technical documentation, consider using "number of tokens" instead of "amount of tokens" as suggested by the LanguageTool.
- Amount of tokens to transfer. + Number of tokens to transfer.Also applies to: 267-267, 309-309, 361-361, 460-460, 478-478
Tools
LanguageTool
[uncategorized] ~237-~237: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... contract to call.| |amount|uint256|Amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
288-288: Avoid duplicate headings.The headings for functions are duplicated. Consider renaming them to avoid confusion.
- ### deposit + ### depositERC20Also applies to: 339-339
Tools
Markdownlint
288-288: null
Multiple headings with the same content(MD024, no-duplicate-heading)
103-103: Use headings instead of emphasis for section titles.Replace emphasis with proper markdown headings for better readability and structure.
- **Parameters** + ## ParametersAlso applies to: 118-118, 125-125, 169-169, 197-197, 204-204, 231-231, 261-261, 280-280, 304-304, 330-330, 356-356, 382-382, 399-399, 414-414, 430-430, 437-437, 454-454, 473-473
Tools
Markdownlint
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
97-97: Ensure completeness of sentences.To form complete sentences, include a subject. This improves clarity and professionalism in documentation.
- Authorizes the upgrade of the contract, sender must be owner. + The contract upgrade is authorized by the sender, who must be the owner.Also applies to: 434-434
Tools
LanguageTool
[uncategorized] ~97-~97: Possible missing preposition found.
Context: ...itializer; ``` ### _authorizeUpgrade *Authorizes the upgrade of the contract, sender mus...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~97-~97: You might be missing the article “the” here.
Context: ...upgrade of the contract, sender must be owner.* ```solidity function _authorizeUpgr...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (2)
v2/docs/solidity.min.jsis excluded by!**/*.min.jsv2/pkg/beaconproxy.sol/beaconproxy.gois excluded by!v2/pkg/**
Files selected for processing (45)
- .github/workflows/generated-files_v2.yaml (1 hunks)
- v2/docs/.gitignore (1 hunks)
- v2/docs/book.css (1 hunks)
- v2/docs/book.toml (1 hunks)
- v2/docs/src/README.md (1 hunks)
- v2/docs/src/SUMMARY.md (1 hunks)
- v2/docs/src/contracts/README.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/interface.Revertable.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertContext.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md (1 hunks)
- v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/README.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/README.md (1 hunks)
- v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/README.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/README.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md (1 hunks)
- v2/docs/src/index.md (1 hunks)
- v2/package.json (1 hunks)
- v2/scripts/generate_docs.sh (1 hunks)
Files skipped from review due to trivial changes (11)
- .github/workflows/generated-files_v2.yaml
- v2/docs/.gitignore
- v2/docs/book.css
- v2/docs/book.toml
- v2/docs/src/contracts/README.md
- v2/docs/src/contracts/evm/README.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md
- v2/docs/src/contracts/evm/interfaces/README.md
- v2/docs/src/contracts/zevm/README.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md
- v2/docs/src/contracts/zevm/interfaces/README.md
Additional context used
Markdownlint
v2/docs/src/contracts/Revert.sol/interface.Revertable.md
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/Revert.sol/struct.RevertContext.md
15-15: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md
17-17: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/README.md
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
16-16: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
22-22: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
28-28: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
34-34: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
40-40: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
46-46: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
52-52: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
53-53: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
54-54: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md
21-21: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
39-39: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
31-31: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
47-47: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md
23-23: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
53-53: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md
87-87: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
96-96: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md
28-28: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
47-47: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
75-75: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
51-51: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
69-69: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
83-83: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/SUMMARY.md
4-4: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
5-5: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
6-6: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
7-7: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
8-8: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
9-9: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
10-10: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
12-12: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
13-13: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
18-18: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
23-23: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
24-24: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
25-25: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
26-26: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
27-27: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
28-28: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
29-29: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
30-30: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
31-31: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
32-32: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
33-33: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
34-34: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
35-35: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
36-36: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
37-37: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
38-38: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md
16-16: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
32-32: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
50-50: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
93-93: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md
45-45: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
105-105: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
124-124: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md
96-96: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
113-113: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
139-139: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
158-158: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/index.md
63-63: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
64-64: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
65-65: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
66-66: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
67-67: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
68-68: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
69-69: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
70-70: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
71-71: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
72-72: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
73-73: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
74-74: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
75-75: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
76-76: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
77-77: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
78-78: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
79-79: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
80-80: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
81-81: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
82-82: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
83-83: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
84-84: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
85-85: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
87-87: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
88-88: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
89-89: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
90-90: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
91-91: Expected: 4; Actual: 6
Unordered list indentation(MD007, ul-indent)
92-92: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
93-93: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
94-94: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
95-95: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
96-96: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
97-97: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
20-20: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
26-26: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
32-32: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
38-38: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
44-44: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
50-50: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
56-56: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
57-57: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
58-58: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md
46-46: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
72-72: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
101-101: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
151-151: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
160-160: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
176-176: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md
118-118: null
Multiple headings with the same content(MD024, no-duplicate-heading)
159-159: null
Multiple headings with the same content(MD024, no-duplicate-heading)
19-19: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
45-45: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
62-62: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
69-69: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
91-91: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
110-110: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
126-126: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
150-150: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
174-174: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
193-193: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
123-123: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
138-138: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
163-163: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
191-191: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
222-222: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md
37-37: null
Multiple headings with the same content(MD024, no-duplicate-heading)
89-89: null
Multiple headings with the same content(MD024, no-duplicate-heading)
210-210: null
Multiple headings with the same content(MD024, no-duplicate-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
51-51: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
77-77: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
104-104: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
130-130: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
149-149: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
199-199: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
218-218: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
236-236: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
258-258: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md
39-39: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
50-50: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
61-61: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
159-159: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
165-165: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
198-198: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
213-213: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
228-228: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
243-243: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
249-249: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
264-264: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
271-271: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
286-286: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
293-293: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
308-308: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
315-315: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
330-330: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
338-338: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
353-353: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
359-359: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
402-402: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
409-409: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
424-424: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
434-434: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
440-440: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
458-458: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
465-465: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
480-480: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
495-495: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
510-510: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
525-525: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
227-227: null
Multiple headings with the same content(MD024, no-duplicate-heading)
253-253: null
Multiple headings with the same content(MD024, no-duplicate-heading)
382-382: null
Multiple headings with the same content(MD024, no-duplicate-heading)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
125-125: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
140-140: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
148-148: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
163-163: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
187-187: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
215-215: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
243-243: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
270-270: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
298-298: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
317-317: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
343-343: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
371-371: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
398-398: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
416-416: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
440-440: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
288-288: null
Multiple headings with the same content(MD024, no-duplicate-heading)
339-339: null
Multiple headings with the same content(MD024, no-duplicate-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
125-125: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
169-169: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
197-197: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
204-204: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
231-231: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
261-261: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
280-280: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
304-304: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
330-330: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
356-356: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
382-382: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
399-399: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
414-414: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
430-430: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
437-437: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
454-454: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
473-473: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
LanguageTool
v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md
[uncategorized] ~13-~13: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...tions ### burnFrom Burns the specified amount of tokens from the specified account. ...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~26-~26: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ill be burned.| |amount|uint256|The amount of tokens to burn.| ### mint Mints t...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~31-~31: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... burn.| ### mint Mints the specified amount of tokens to the specified account. *E...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~44-~44: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...will be minted.| |value|uint256|The amount of tokens to mint.| |internalSendHash...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md
[uncategorized] ~21-~21: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...are withdrawn.| |amount|uint256|The amount of tokens withdrawn.| ### WithdrawnAnd...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~36-~36: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...are withdrawn.| |amount|uint256|The amount of tokens withdrawn.| |data|bytes|T...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~52-~52: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...are withdrawn.| |amount|uint256|The amount of tokens withdrawn.| |data|bytes|T...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md
[uncategorized] ~61-~61: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...he ZRC20 token.| |value|uint256|The amount of tokens withdrawn.| |gasfee|`uint25...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md
[uncategorized] ~34-~34: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ss for the tokens.| |amount|uint256|Amount of tokens to withdraw.| ### withdrawA...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~53-~53: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... contract to call.| |amount|uint256|Amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~59-~59: You might be missing the article “the” here.
Context: ... WithdrawAndRevert transfers tokens to Gateway and call a contract with a revert funct...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~59-~59: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...dRevert transfers tokens to Gateway and call a contract with a revert functionality ...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~81-~81: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... contract to call.| |amount|uint256|Amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md
[uncategorized] ~22-~22: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ERC20 token.| |amount|uint256|The amount of tokens withdrawn.| ### WithdrawnAnd...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~38-~38: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ERC20 token.| |amount|uint256|The amount of tokens withdrawn.| |data|bytes|T...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~57-~57: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ERC20 token.| |amount|uint256|The amount of tokens withdrawn.| |data|bytes|T...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ntract called.| |amount|uint256|The amount of tokens transferred.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md
[uncategorized] ~50-~50: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~79-~79: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~110-~110: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~128-~128: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens received.|(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md
[uncategorized] ~101-~101: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~118-~118: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~144-~144: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~162-~162: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens received.| ## Errors ### Ze...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md
[uncategorized] ~77-~77: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |`internalSendH...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~106-~106: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~137-~137: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...raw tokens to.| |amount|uint256|The amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~155-~155: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens received.| ### _mintTo *mi...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md
[uncategorized] ~25-~25: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...tract to call.| |amount|uint256|The amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~31-~31: You might be missing the article “the” here.
Context: ...# executeRevert Transfers msg.value to destination contract and executes it's onRevert fun...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~97-~97: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...tract to call.| |amount|uint256|The amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~131-~131: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s of the receiver.| |amount|uint256|Amount of tokens to deposit.| |asset|`addres...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~179-~179: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s of the receiver.| |amount|uint256|Amount of tokens to deposit.| |asset|`addres...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
[duplication] ~13-~13: Possible typo: you repeated a word
Context: ...way contract.* ## State Variables ### gateway Gateway contract. ```solidity IGatewayEVM pub...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~41-~41: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ag if contract supports legacy methods (eg. deposit). ```solidity bool public sup...(E_G)
[uncategorized] ~169-~169: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to withdraw.| ### withdrawA...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~197-~197: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~228-~228: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to withdraw.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md
[uncategorized] ~32-~32: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~56-~56: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |chainId|`uin...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~82-~82: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~109-~109: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |chainId|`uin...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to deposit.| |target|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~179-~179: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~205-~205: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~223-~223: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ss-chain call.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~263-~263: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to revert.| |target|`addres...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md
[uncategorized] ~347-~347: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ucceeded/failed.| ### burn Burns an amount of tokens. ```solidity function burn...(AMOUNTOF_TO_NUMBEROF)
[style] ~474-~474: To form a complete sentence, be sure to include a subject.
Context: ...ress *Updates system contract address. Can only be updated by the fungible module....(MISSING_IT_THERE)
[style] ~489-~489: To form a complete sentence, be sure to include a subject.
Context: ...ess *Updates gateway contract address. Can only be updated by the fungible module....(MISSING_IT_THERE)
[style] ~504-~504: To form a complete sentence, be sure to include a subject.
Context: ...### updateGasLimit *Updates gas limit. Can only be updated by the fungible module....(MISSING_IT_THERE)
[style] ~519-~519: To form a complete sentence, be sure to include a subject.
Context: ...colFlatFee *Updates protocol flat fee. Can only be updated by the fungible module....(MISSING_IT_THERE)
v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
[uncategorized] ~122-~122: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~144-~144: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~167-~167: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...--|-----------| |amount|uint256|The amount of tokens to transfer.| |to|address...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~192-~192: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~220-~220: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |zrc20|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~248-~248: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |chainId|`uin...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~275-~275: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...xternal chain.| |amount|uint256|The amount of tokens to withdraw.| |chainId|`uin...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~322-~322: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to deposit.| |target|`addre...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~349-~349: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~377-~377: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~403-~403: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ss-chain call.| |amount|uint256|The amount of tokens to transfer.| |target|`addr...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~445-~445: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...e ZRC20 token.| |amount|uint256|The amount of tokens to revert.| |target|`addres...(AMOUNTOF_TO_NUMBEROF)
v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
[uncategorized] ~97-~97: Possible missing preposition found.
Context: ...itializer; ``` ### _authorizeUpgrade *Authorizes the upgrade of the contract, sender mus...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~97-~97: You might be missing the article “the” here.
Context: ...upgrade of the contract, sender must be owner.* ```solidity function _authorizeUpgr...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~152-~152: You might be missing the article “the” here.
Context: ...# executeRevert Transfers msg.value to destination contract and executes it's onRevert fun...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~237-~237: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... contract to call.| |amount|uint256|Amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~267-~267: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... contract to call.| |amount|uint256|Amount of tokens to transfer.| |data|bytes...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~309-~309: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s of the receiver.| |amount|uint256|Amount of tokens to deposit.| |asset|`addres...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~361-~361: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...s of the receiver.| |amount|uint256|Amount of tokens to deposit.| |asset|`addres...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~434-~434: Possible missing preposition found.
Context: ...|address|Address of the ERC20 token.| |to|address`|Address to reset the app...(AI_EN_LECTOR_MISSING_PREPOSITION)
[uncategorized] ~460-~460: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to transfer.| ### transferT...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~478-~478: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...f the ERC20 token.| |amount|uint256|Amount of tokens to transfer.|(AMOUNTOF_TO_NUMBEROF)
Additional comments not posted (11)
v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md (1)
1-10: Documentation looks good.The documentation for the
zContextstruct is clear and well-formatted. The Git source link provides easy access to the source code.v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md (1)
1-12: Documentation looks good.The documentation for the
CoinTypeenum is clear and includes an important note regarding the Zeta value. The Git source link is correctly provided.v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md (1)
1-11: Documentation looks good.The documentation for the
onCrossChainCallfunction is clear and well-structured. The Git source link is correctly provided.v2/scripts/generate_docs.sh (1)
1-13: Shell script looks good.The script effectively automates the documentation generation process and handles OS-specific differences in
sedusage. The logic is clear and concise.v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md (1)
1-18: Documentation looks good.The documentation for the
onCrossChainCallandonRevertfunctions is clear and well-structured. The Git source link is correctly provided.v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md (1)
1-30: Documentation is well-structured and clear.The file provides a clear and consistent documentation format for the ZRC20 metadata interface.
v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md (1)
1-51: Well-structured interface documentation.The documentation for the
ISysteminterface is clear and well-organized, providing necessary details for each function.v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md (1)
1-55: Clear documentation for ZRC20 events.The documentation for the
ZRC20Eventsinterface is clear and well-organized, providing necessary details for each event.v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md (1)
1-79: Well-structured error documentation.The documentation for the
IGatewayEVMErrorsinterface is clear and well-organized, providing necessary details for each error.v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md (1)
1-88: Well-structured documentation.The documentation for the
IWETH9interface is clear and well-organized, providing a comprehensive overview of the functions and events.v2/package.json (1)
17-19: Integration of documentation generation is well-implemented.The addition of the
docsscript and its integration into thegeneratescript effectively streamlines the documentation process as part of the build workflow.
| |`revertOptions`|`RevertOptions`|Revert options.| | ||
|
|
||
|
|
||
| ### deposit |
There was a problem hiding this comment.
Avoid duplicate headings.
The headings for deposit and depositAndCall are duplicated. Consider differentiating them for clarity.
- ### deposit
+ ### deposit (ETH)- ### depositAndCall
+ ### depositAndCall (ETH)Also applies to: 159-159
Tools
Markdownlint
118-118: null
Multiple headings with the same content(MD024, no-duplicate-heading)
|
I tried fixing the generated files workflow, but I'm just going to do it in a separate PR. |
(ignore the path in URL, I put it into "frontend" for testing purposes) |
docs/directory usingforge docindex.mdfile so that it can be published in the docsSummary by CodeRabbit
New Features
.gitignorefile to exclude thebook/directory from version control.README.mdandSUMMARY.md.Documentation
Style