Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect underscore when using blank lines #454

Open
0xneves opened this issue Dec 15, 2023 · 0 comments
Open

Incorrect underscore when using blank lines #454

0xneves opened this issue Dec 15, 2023 · 0 comments

Comments

@0xneves
Copy link

0xneves commented Dec 15, 2023

When using empty lines in the NatSpec like the following:

    /**
     * @dev Displayed when the amount of {ISwap-Asset} has a length of zero.
     *
     * NOTE: The `biding` or `asking` array must not be empty to avoid mistakes
     * when creating a swap. Assuming one side of the swap is empty, the
     * correct approach should be the usage of {transferFrom} and we reinforce
     * this behavior by requiring the length of the array to be bigger than zero.
     */
    error InvalidAssetsLength();

The generation will try to embrace all content in underscore (_) like so:

   ``solidity
   error InvalidAssetsLength()
   ``

   \_Displayed when the amount of {ISwap-Asset} has a length of zero.

   NOTE: The `biding` or `asking` array must not be empty to avoid mistakes
   when creating a swap. Assuming one side of the swap is empty, the
   correct approach should be the usage of {transferFrom} and we reinforce
   this behavior by requiring the length of the array to be bigger than zero.\_

But the .md will consider it invalid when generating the output, not processing the underscore correctly, resulting in:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant