Repository navigation
Hold only the visible overloads to the README's documented defaults [patch] - #186
Open
matt-edmondson wants to merge 1 commit into
Open
matt-edmondson wants to merge 1 commit into
matt-edmondson wants to merge 1 commit into
Conversation
…patch] The README API test required every overload's same-named parameter to carry the documented default. The binary-compatibility overloads from #166 have no defaults by design, so main has been red since #178. They are marked [EditorBrowsable(Never)] and are not what the README documents, so the default check now skips them. A wrong default on a visible overload still fails. Fixes #183 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017vfJW6FzBtSrY5LKUuDYce
|
matt-edmondson
pushed a commit
that referenced
this pull request
Nov 5, 2026
…from #186) ReadmeTests fails on main because the EditorBrowsable(Never) binary-compatibility overloads carry no defaults by design. Ported from open PR #186 so this PR's CI shows its own result. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017vfJW3SsCYipEZieVhB1tG
This was referenced Nov 6, 2026
matt-edmondson
pushed a commit
that referenced
this pull request
Nov 6, 2026
EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults fails on main at 5f420d9. This is #186's change, verbatim, so the two merge cleanly whichever lands first. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017vfJW5JaSLvVsxrZiNZpKh
matt-edmondson
pushed a commit
that referenced
this pull request
Nov 7, 2026
Ports the fix from #186 (for #183). The README API test failed on main because the binary-compatibility overloads deliberately carry no defaults, so this PR's CI was red for a reason outside its change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017vfJW4tA1FYwsQrBAjGqs7
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.
Fixes #183
What was wrong
EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaultsrequired every overload's same-named parameter to carry the README's default. The binary-compatibility overloads added in #166 have no defaults on purpose, because defaults on both sets would make calls ambiguous. So the test has failed on every OS since #178, and main can't release.Change
The default check now looks only at overloads that aren't marked
[EditorBrowsable(EditorBrowsableState.Never)]. Those are the overloads the README documents. Every compatibility overload inTextFilter.BinaryCompatibility.cscarries that attribute. The existence and parameter-name checks run against the same visible set.Verification
dotnet teston this branch: 268 passed, 0 failedIsMatchfilterTypedefault toTextFilterType.Regexas a temporary edit. The test still fails withIsMatch(filterType) is documented as defaulting to TextFilterType.Regex, so a wrong default on a visible overload is still caught.Generated by Claude Code