Improve TestCase note example#164
Open
jeet-dekivadia wants to merge 1 commit into
Open
Conversation
Author
|
I checked the failing checks here as well. The Python package matrix is failing in the existing This PR still only changes the |
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.
Purpose
Improve the
marbles.core.TestCasedocstring example so it demonstrates why anoteis useful when external data changes unexpectedly.Fixes #117.
Approach
Add a focused external-catalog example for the
TestCasedocstring while leaving the quickstart tutorial fixtures unchanged. The note explains the expected threshold and what a lower count may indicate.Tests for New Behavior
Documentation-only change.
git diff --checkpython3 -m py_compile docs/examples/catalog_data.py marbles/core/marbles/core/marbles.pyliteralincludetarget existsChecklist
nox -s flake8to make sure code style is consistentLearning
The existing quickstart example is useful for showing failure output, but a separate docstring example makes the value of author-provided context clearer without changing generated quickstart fixtures.