Remove asTreeDiagram render style and clarify diagram guidance#24
Merged
Conversation
The asTreeDiagram render style produces narrow horizontal trees that exceed PDF page width. The default render (no directive) uses the package/folder-diagram style — roughly rectangular, with a folder tab and a members compartment — which fits document pages correctly. - Remove all 'render asTreeDiagram;' lines from the Views code example - Replace the 'render asTreeDiagram' reference in the Critical distinction paragraph with 'asInterconnectionDiagram' (a neutral alternative) - Add an explicit note explaining that the default style is preferred and why asTreeDiagram should be avoided Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the SysML2 modeling standards documentation to more clearly distinguish diagram scoping (controlled by expose) from rendering style (controlled by render <kind>;) in view usages, reducing confusion about what affects diagram contents.
Changes:
- Removed
render asTreeDiagram;from the exampleviewusages to avoid implying it influences scope. - Updated the explanatory text to use
asInterconnectionDiagramas the rendering-style example and explicitly state rendering has no scope impact.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This pull request updates the SysML2 modeling standards documentation to clarify the distinction between diagram scoping and rendering style in view definitions. The main change is to correct the example rendering style and clarify its effect.
Documentation and clarity improvements:
src/.github/standards/sysml2-modeling.mdto remove therender asTreeDiagram;lines from view definitions and clarify in the explanation thatrender <kind>;(e.g.,asInterconnectionDiagram) only affects rendering style, not scope.