Repository navigation
fix: Ignore docstrings in guppy.unitary classes - #2514
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the change adding leading-docstring support to unitary classes.
No open issues 🎉
What changed in this PR
Adds support for leading docstrings in @guppy.unitary classes while preserving existing method validation and rejecting other unsupported statements.
Changes:
- Accepts a string expression as the first statement in a unitary class.
- Adds an integration test compiling a documented unitary class used with the dagger modifier.
| File | Description |
|---|---|
tests/integration/test_modifier.py |
Adds regression coverage for a unitary class with a docstring. |
guppylang-internals/src/guppylang_internals/checker/unitary_checker.py |
Allows leading docstrings while retaining class-body validation. |
Review effort: Balanced
qartik
reviewed
Nov 10, 2026
maximilianruesch
requested changes
Nov 11, 2026
maximilianruesch
left a comment
maximilianruesch
left a comment
Collaborator
There was a problem hiding this comment.
Imo this is more of a bugfix, since you are not doing anything with the docstrings (other than ignore them), and the test makes the whole change look more like a
fix: Ignore docstrings in guppy.unitary classes
Thoughts?
GBoydQ
changed the title
maximilianruesch
added
B-backport-nominated
maximilianruesch
added
B-backport-accepted
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds support for docstrings at the start of
@guppy.unitarydecorated classes