mathworks / mathworks/test-framework-extensions

Update FailOnSpecificWarningsPlugin doc to explain usage vs verifyWarningFree

Open Beginner friendly
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MATLAB
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Need to explain when you would use FailOnSpecificWarningsPlugin vs verifyWarningFree. Explanation is that:

  1. the plugin applies across the entire test suite whereas verifyWarningFree is for use within a test point;
  2. verifyWarningFree will produce a qualification failure if any warning is produced (like the built-in FailOnWarningsPlugin) whereas FailOnSpecificWarningsPlugin will only produce a qualification failure if specific warnings are produced.

verifyWarningNotProduced might be a useful addition to this toolbox.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation for FailOnSpecificWarningsPlugin and verifyWarningFree, then compare how each is used and how warnings cause qualification failures. Update the usage guidance to explain their scope and warning behavior, and decide whether verifyWarningNotProduced belongs in the toolbox documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
matlab
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.