docs: fix orthogonal projection description and add cross-links by redfish4ktc · Pull Request #1030 · maxGraph/maxGraph · GitHub
Skip to content

docs: fix orthogonal projection description and add cross-links#1030

Merged
tbouffard merged 1 commit into
mainfrom
docs/fix_perimeter_and_edgestyle
Mar 26, 2026
Merged

docs: fix orthogonal projection description and add cross-links#1030
tbouffard merged 1 commit into
mainfrom
docs/fix_perimeter_and_edgestyle

Conversation

@redfish4ktc

@redfish4ktc redfish4ktc commented Mar 26, 2026

Copy link
Copy Markdown

In perimeters.md, replace the reference to the internal Graph.isOrthogonal method with a user-facing explanation: orthogonal behavior is determined by the isOrthogonal metadata property of the EdgeStyle in the EdgeStyleRegistry.

In edge-styles.md, replace the placeholder in the EdgeStyleMetaData warning with details about the impact of
isOrthogonal on perimeter point computation.

Add cross-links between both pages on this topic.

Summary by CodeRabbit

  • Documentation
    • Clarified how edge terminal points are computed on vertex perimeters.
    • Explained how edge styling properties control orthogonal projection behavior.
    • Added cross-references between related documentation sections.

In perimeters.md, replace the reference to the internal
`Graph.isOrthogonal` method with a user-facing explanation:
orthogonal behavior is determined by the `isOrthogonal` metadata
property of the EdgeStyle in the EdgeStyleRegistry.

In edge-styles.md, replace the XXX placeholder in the
EdgeStyleMetaData warning with details about the impact of
`isOrthogonal` on perimeter point computation.

Add cross-links between both pages on this topic.
@redfish4ktc redfish4ktc added the documentation Improvements or additions to documentation label Mar 26, 2026
@coderabbitai

coderabbitai Bot commented Mar 26, 2026

Copy link
Copy Markdown

@sonarqubecloud

Copy link
Copy Markdown

@tbouffard tbouffard merged commit ddf5df6 into main Mar 26, 2026
8 checks passed
@tbouffard tbouffard deleted the docs/fix_perimeter_and_edgestyle branch March 26, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants