-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Clarify documentation and examples for relations #10
Conversation
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
==========================================
+ Coverage 75.32% 75.63% +0.31%
==========================================
Files 69 69
Lines 5231 5335 +104
==========================================
+ Hits 3940 4035 +95
- Misses 1291 1300 +9
☔ View full report in Codecov by Sentry. |
The use of object is overly generic and is easily confused with its other meaning. Target is a more natural alternative
c594663
to
9558776
Compare
f90bf66
to
2ee705b
Compare
|
||
A relation is used as a *parameterized* component, which requires an `Entity` to be fully instantiated. | ||
This allows forming hierarchies such as *parent-child* relations for transforms and UI, as well as arbitrary graphs. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe here would be a good place to reinforce the target-subject terms after parent-child? Not sure.
Example:
This allows forming hierarchies such as *parent-child* (target-subject) relations for transforms and UI...
Not really sure because the relation can have any arbitrary direction, maybe this only applies to the child_of
type of relation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, I've clarified it a bit more :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it, everything seems more detailed.
Only comment is the one about reinforcing the target-subject, but I'm not totally sure it will be useful, up to you.
b43825a
to
53184f2
Compare
No description provided.