Skip to content

Conversation

beeb
Copy link
Owner

@beeb beeb commented May 1, 2025

Due to argotorg/solidity#9139, solc considers doc-comments starting with //// or /*** as not being valid NatSpec.

To keep the same validation behavior in lintspec, the parser was changed and now errors in those cases.

Breaking Change

This is a breaking change because the return value of all parser combinators in the natspec module changed from winnow::error::Result to winnow::error::ModalResult.

beeb added 3 commits May 1, 2025 17:02
BREAKING CHANGE: the return type for all the NatSpec parsers are now `ModalResult`
@beeb beeb changed the title fix(natspec): consider some comment delimiters as errors fix(natspec)!: consider some comment delimiters as errors May 1, 2025
@beeb beeb merged commit 3156ea0 into main May 1, 2025
@beeb-release-plz beeb-release-plz bot mentioned this pull request May 1, 2025
@beeb beeb deleted the fix-single-line-comment branch May 2, 2025 05:32
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

Successfully merging this pull request may close these issues.

1 participant