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

Handle Solidity NatSpec whitespace #32

Open
fulldecent opened this issue Mar 9, 2022 · 2 comments
Open

Handle Solidity NatSpec whitespace #32

fulldecent opened this issue Mar 9, 2022 · 2 comments

Comments

@fulldecent
Copy link

For a function specification like this:

/// @notice Perform initial contract setup
/// @dev    The initializer modifier ensures this is only called once, the owner should confirm this was properly
///         performed before publishing this contract address.
/// @param  _initialFee          fee to be paid on each sale, in basis points
/// @param  _initialFeeRecipient wallet to collets fees
/// @param  _initialPaymentToken address of the token that is used for settlement

I am hoping it can be parsed as:

Notice:

Perform initial contract setup

Dev:

The initializer modifier ensures this is only called once, the owner should confirm this was properly performed before publishing this contract address.

Param _initialFee:

fee to be paid on each sale, in basis points

Param _initialFeeRecipient :

wallet to collets fees

Param _initialPaymentToken :

address of the token that is used for settlement


Please let me know how this works and how I can help.

I am also the maintainer of the Solidity Style Guide and the Solidity NatSpec specification.

@clemlak
Copy link
Contributor

clemlak commented Mar 10, 2022

Just to be sure to understand the issue here: you are talking about extra spaces that are not managed correctly? If that's so, would trimming the extra spaces work?

@fulldecent
Copy link
Author

Trimming whitespaces before and after each line and then combining lines with one space would fix it.

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

2 participants