docgen: compact field metadata line and deprecation callout#923
Merged
Conversation
Replace the per-field property table with a single italic metadata line (type, format, nullable, default, read-only, write-once, sensitive, tags) and render deprecation as a blockquote callout naming the redirect target. Constraints and examples sections are unchanged. Shrinks generated docs and makes field headers scannable. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
zeevdr
added
enhancement
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
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.
Summary
| Property | Value |table, which made schema pages hard to scan; this replaces it with a one-line italic metadata summary (type, format, nullable, default, read-only, write-once, sensitive, tags).Test plan
make test— all modules pass./scripts/check-coverage.sh— sdk/tools 96.4% against a 96.0% ratchetgofumpt -l,go build ./...,go vet ./...clean on sdk/toolsCloses #922