Skip to content

docs: Improve documentation comment for testplan.Element.has_tags#217

Merged
rswarbrick merged 1 commit into
lowRISC:masterfrom
rswarbrick:has-tags-docs
May 26, 2026
Merged

docs: Improve documentation comment for testplan.Element.has_tags#217
rswarbrick merged 1 commit into
lowRISC:masterfrom
rswarbrick:has-tags-docs

Conversation

@rswarbrick

Copy link
Copy Markdown
Contributor

This was partly motivated by the fact I couldn't immediately see whether the test was an AND or an OR.

@rswarbrick rswarbrick requested a review from AlexJones0 May 21, 2026 12:46

@AlexJones0 AlexJones0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM modulo one nit.

Comment thread src/dvsim/testplan.py Outdated
Tags may be preceded with `-` to exclude the testpoints that contain
that tag.
The element should match every item in the set of tags. If one of these
elements is preceded with "-", the meaning is negated (so the element

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this might be intended to be:

Suggested change
elements is preceded with "-", the meaning is negated (so the element
tags is preceded with "-", the meaning is negated (so the element

(or "items" also makes sense in the given context)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops: thanks!

This was partly motivated by the fact I couldn't immediately see
whether the test was an AND or an OR.

Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>
@rswarbrick rswarbrick added this pull request to the merge queue May 26, 2026
Merged via the queue into lowRISC:master with commit be17a76 May 26, 2026
6 checks passed
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.

2 participants