Clarify best practice #5 on adding fields to included types#52
Open
Clarify best practice #5 on adding fields to included types#52
Conversation
Distinguish extension (data_type_def + data_type_inc) from inclusion (data_type_inc only), and add a VectorData/resolution example. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The file had no section title, which prevented Sphinx from showing it in the index toctree. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
RST requires continuation lines of an enumerated list item to align with the text after the marker; without indentation, list items 2-8 broke out of the list and rendered inconsistently. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a 1em bottom margin to arabic ordered-list items so the Best Practices page reads less like a wall of text. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
source/best_practices.rstto explicitly distinguish extension (data_type_def+data_type_inc) from inclusion-only (data_type_incwithoutdata_type_def).VectorData+resolutionexample to illustrate the discouraged pattern.Best Practicessection heading so the page renders in the Sphinx toctree (it was previously missing a title and not appearing in the table of contents).The previous wording of #5 said "adding ... using
data_type_incis partially supported," which could be read as covering inheritance (the correct pattern) as well as inclusion-only (the discouraged pattern). The new wording mirrors the explicit phrasing used in best practice #6.Test plan
🤖 Generated with Claude Code