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

Bug: New Natspec for 0.8.20+ makes changes incompatitble #256

Closed
sambacha opened this issue Sep 30, 2023 · 3 comments
Closed

Bug: New Natspec for 0.8.20+ makes changes incompatitble #256

sambacha opened this issue Sep 30, 2023 · 3 comments
Assignees
Labels
bug Something isn't working
Milestone

Comments

@sambacha
Copy link
Contributor

sambacha commented Sep 30, 2023

docs.soliditylang.org/en/v0.8.20/natspec-format.html

According to the v0.8.20 release notes, structs and enums can now be documented with NatSpec comments.

However, Solidity's documentation website doesn't make any references to these newly introduced capabilities. For example, the Tags table should be updated to explain that the @title, @author, @notice, and @dev tags can now be applied to structs and enums.

see ethereum/solidity#14045
see ethereum/solidity#11156
see ethereum/solidity#14045
see ethereum/solidity#14529

Additionally, Natspec comments disallows anything not - or [A-Z,0-9].

This is now broken

https://github.com/manifoldfinance/mevETH2/blob/c7abc63681f44fa1a016f68c0191b7474592bfac/src/WagyuStaker.sol#L1C1-L11C4

/// SPDX-License-Identifier: SSPL-1.-0

/**
 * @custom:org.protocol='mevETH LST Protocol'
 * @custom:org.security='mailto:[email protected]'
 * @custom:org.vcs-commit=$GIT_COMMIT_SHA
 * @custom:org.vendor='CommodityStream, Inc'
 * @custom:org.schema-version="1.0"
 * @custom.org.encryption="manifoldfinance.com/.well-known/pgp-key.asc"
 * @custom:org.preferred-languages="en"
 */
@sambacha sambacha added the bug Something isn't working label Sep 30, 2023
@sambacha sambacha added this to the v1.0 RC milestone Sep 30, 2023
@sambacha
Copy link
Contributor Author

Additionally, see this issue where depending on spacing of ~~~@inheritdoc~~~ ethereum/solidity#14397 can effect if it even compiles.

@ControlCplusControlV
Copy link
Contributor

wtf

@sambacha
Copy link
Contributor Author

We just went with a dope waifu

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants