doc(mixin): clarify precedence rules and document limitations#196
Merged
Conversation
Rewrite the Mixin godoc into three labeled sections: * Argument order and precedence, with a worked host example showing that the primary always wins on collision and that mixins are listed in decreasing priority order. * What gets merged, enumerating exactly which fields are filled from empty primaries, which are merged entry-by-entry with collision warnings, and which are unioned silently (schemes, consumes, produces). * Notes and limitations, with cross-references to the new goswagger.io FAQ entries on YAML anchor preservation and on output ordering. This is a documentation-only change addressing user-confusion issues in go-swagger/go-swagger: * go-swagger/go-swagger#1823 (precedence) * go-swagger/go-swagger#1928 (YAML anchors not preserved) * go-swagger/go-swagger#2130 (output is alphabetically ordered; this is an architectural constraint inherited from the underlying spec model, not fixable here) Companion FAQ entries land in go-swagger/go-swagger docs/faq/faq_swagger.md and the canonical reference moves into docs/usage/mixin.md. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #196 +/- ##
=======================================
Coverage 92.01% 92.01%
=======================================
Files 30 30
Lines 3394 3394
=======================================
Hits 3123 3123
Misses 189 189
Partials 82 82 ☔ View full report in Codecov by Sentry. |
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.
Rewrite the Mixin godoc into three labeled sections:
This is a documentation-only change addressing user-confusion issues in go-swagger/go-swagger:
Companion FAQ entries land in go-swagger/go-swagger docs/faq/faq_swagger.md and the canonical reference moves into docs/usage/mixin.md.
Change type
Please select: 🆕 New feature or enhancement|🔧 Bug fix'|📃 Documentation update
Short description
Fixes
Full description
Checklist