Skip to content
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

Merged
merged 9 commits into from
Oct 28, 2023
Merged

Conversation

ten3roberts
Copy link
Owner

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Oct 17, 2023

Codecov Report

Attention: 40 lines in your changes are missing coverage. Please review.

Comparison is base (2fd4fd7) 75.32% compared to head (53184f2) 75.63%.
Report is 11 commits behind head on main.

❗ 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     
Files Coverage Δ
src/archetypes.rs 97.46% <100.00%> (+0.06%) ⬆️
src/cascade/mod.rs 0.00% <ø> (ø)
src/entity/mod.rs 85.13% <ø> (ø)
src/fetch/mod.rs 78.57% <ø> (ø)
src/fetch/source.rs 61.90% <100.00%> (+2.38%) ⬆️
src/macros.rs 100.00% <ø> (ø)
src/query/dfs.rs 72.09% <100.00%> (+0.77%) ⬆️
src/query/topo.rs 77.10% <100.00%> (ø)
src/query/walk.rs 69.23% <100.00%> (ø)
src/world.rs 88.91% <100.00%> (+0.27%) ⬆️
... and 6 more

... and 18 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

The use of object is overly generic and is easily confused with its
other meaning. Target is a more natural alternative

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.

Copy link

@pherrymason pherrymason Oct 20, 2023

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.

Copy link
Owner Author

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 :)

Copy link

@pherrymason pherrymason left a 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.

@ten3roberts ten3roberts merged commit 47a3b0f into main Oct 28, 2023
6 checks passed
@ten3roberts ten3roberts deleted the relations branch October 28, 2023 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants