[REFACTOR](schema) Split system.primitive into numeric and geometric modules#552
Draft
Seth Fitzsimmons (sethfitz) wants to merge 4 commits into
Draft
[REFACTOR](schema) Split system.primitive into numeric and geometric modules#552Seth Fitzsimmons (sethfitz) wants to merge 4 commits into
Seth Fitzsimmons (sethfitz) wants to merge 4 commits into
Conversation
…modules `overture.schema.system.primitive` mixed two unrelated concerns: portable numeric NewTypes (int8, uint32, float64, etc.) and geometric types (BBox, Geometry, GeometryType, GeometryTypeConstraint). The docs reference page this produced was titled "Primitive Types" at system/primitive/primitives even though it only covered numeric types. Numeric types move to a new numeric.py module; BBox and Geometry move to a new geometric package. The primitive package is removed and every import across the workspace (themes, common, codegen, and their tests, including several doctest examples) is updated to the correct module. The aggregate docs pages move with their source: system/numeric.md (title "Numeric Types") and system/geometry.md, both flat under system/ like the existing scalar type pages, rather than nested under primitive/. Fixes #464. Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
…ings Follow-up to the numeric/geometric split: the system package docstring and the new geometric module docstring still described these types as "primitive types" / "geometric primitives", the exact wording the split was meant to retire. Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
…trings Commit 0301bf7 left "primitive" in several docstrings after the system.primitive split into numeric and geometric modules. Remove the remaining instances in __init__.py, geometric/geom.py, geometric/bbox.py, and string.py so the term no longer appears anywhere in the package. Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
🗺️ Schema reference docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
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.
Closes #464.
Splits
overture.schema.system.primitivealong its two concerns:uint8throughfloat64) move tooverture.schema.system.numericBBoxandGeometrymove tooverture.schema.system.geometricprimitivepackage is removed; imports updated across ~35 filesThe generated reference page for the numeric types moves from
system/primitive/primitives("Primitive Types") tosystem/numeric("Numeric Types"), and the geometry page fromsystem/primitive/geometrytosystem/geometry. Remaining "primitive" wording in system-package docstrings is retired with it.The BBox/Geometry move implements Victor Schappert (@vcschapp)'s suggestion from the issue thread; flagging it here since it wasn't settled there.