docs: fix orthogonal projection description and add cross-links - #1030
Merged
Conversation
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.
WalkthroughDocumentation updates clarifying that edge orthogonality determination has been moved from a hardcoded list in Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
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
2 participants
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.
In perimeters.md, replace the reference to the internal
Graph.isOrthogonalmethod with a user-facing explanation: orthogonal behavior is determined by theisOrthogonalmetadata property of the EdgeStyle in the EdgeStyleRegistry.In edge-styles.md, replace the placeholder in the EdgeStyleMetaData warning with details about the impact of
isOrthogonalon perimeter point computation.Add cross-links between both pages on this topic.
Summary by CodeRabbit