Document the page header's inline mode, which the last change skipped - #93
Merged
Conversation
`CLAUDE.md` has a post-change checklist and I ran none of it: CHANGELOG under `[Unreleased]`, README where the API changed, and the relevant `doc/` pages. The code in #92 was right and the paper trail was missing, which for a released package is half the change. The CHANGELOG entry carries the measurement rather than only the fix: the combination that overflows is a theme override plus the missing flag, seen at 40 logical pixels in a host app and reproduced at 79 in the suite. `doc/architecture/manager.md` gains the case worth documenting, which is not "here is a new field" but "setting the container alone overflows". Anybody overriding `containerClassName` into a row is one paragraph away from the bug, so the paragraph sits under the override rather than under the flag. `doc/basics/components.md`'s one-line summary says the header stacks below `sm` and what turns that off. README is deliberately untouched: its component table is a name and a phrase, and the detail belongs in `doc/`, where it now is.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Follow-up to #92, which shipped the code and none of the paper.
CLAUDE.mdhas a post-change checklist and I ran none of it.For an unreleased package that would be untidy. For a published one it is half the change: the field is reachable and nothing tells anybody it exists or what it prevents.
What is here
CHANGELOG.mdunder[Unreleased], split Fixed / Changed. It carries the measurement rather than only the fix: the combination that overflows is a theme override plus the missing flag, seen at 40 logical pixels in a host app and reproduced at 79 in the suite. TheChangedhalf states plainly thatbool?is not breaking, because that is the first question a reader will have.doc/architecture/manager.mdgains the case worth documenting, which is not "here is a new field" but "setting the container alone overflows". Anybody overridingcontainerClassNameinto a row is one paragraph away from the bug, so the paragraph sits under the override, with the two-line snippet that gets it right.doc/basics/components.mdgains one clause on its summary line: the header stacks belowsm, and what turns that off.What is deliberately not here
README. Its component table is a name and a phrase per widget, and the header's entry is still accurate. Putting the inline caveat there would be the third copy of it. The checklist says "update if features, API, or usage changes", and the usage that changed is documented where usage lives.
One honest note on process
CLAUDE.mdasks for red-green-refactor, and #92 went code-first: I wrote the fix, then the tests, then proved them red by reverting the fix. The property that matters held (A RenderFlex overflowed by 79 pixels on the rightis what the test reports without the fix, so it fails for the reason it claims) but the order was wrong, and saying so is cheaper than implying otherwise.Verification
dart format --set-exit-if-changed .clean,dart analyzeclean, 1253 tests pass. No source change in this PR.