docs: document that expose() with no groups raises TypeError - #39
Merged
Conversation
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
1 participant
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.
expose()raisesTypeErrorwhen called with no groups (_collect_fixturesguards it, and
test_raises_when_called_with_no_groupscovers it). The README's## APIsection listed theValueErrorfor a cross-group duplicate name but notthis one, so a user reading the documented surface saw only half the error
contract.
Noticed while auditing the
expose()paragraph in #38; left out of that PR asunrelated to the behaviour fix.
Docs only, no behaviour change. Verified clean against
docs/migrate-off-planning(
git merge-tree), which rewords the same paragraph.