Skip to content

Incorrect underscore when using blank lines #454

@0xneves

Description

@0xneves

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions