manifoldfinance / mevETH2

mevETH LST Protocol - Repo has migrated see link
https://github.com/MEV-Protocol/meveth
27 stars 2 forks source link

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

Closed sambacha closed 11 months ago

sambacha commented 11 months ago

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 https://github.com/ethereum/solidity/issues/14045 see https://github.com/ethereum/solidity/issues/11156 see https://github.com/ethereum/solidity/issues/14045 see https://github.com/ethereum/solidity/issues/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:security@manifoldfinance.com'
 * @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 commented 11 months ago

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

ControlCplusControlV commented 11 months ago

wtf

sambacha commented 11 months ago

We just went with a dope waifu