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

Refactor InstanceId #999

Merged
merged 17 commits into from
Jan 31, 2023
Merged

Refactor InstanceId #999

merged 17 commits into from
Jan 31, 2023

Conversation

emilk
Copy link
Member

@emilk emilk commented Jan 30, 2023

This simplifies and renamed InstanceId to InstancePath (because that is what it is).

I wonder if Instance should be renamed InstanceIndex or InstanceId, since the concept "instance" means an instance of an entity, e.g. a point in a point cloud.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I've added a line to CHANGELOG.md (if this is a big enough change to warrant it)

@emilk emilk marked this pull request as ready for review January 30, 2023 21:05
@jleibs jleibs self-requested a review January 31, 2023 00:39
Copy link
Member

@jleibs jleibs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wish github had a way to hide "trivial renames" in addition to white-space. Couple of very small nits but overall looks good.

crates/re_log_types/src/component_types/instance.rs Outdated Show resolved Hide resolved
/// A special value indicating that this [`Instance]` is referring to all instances,
/// for instance all points in a point cloud entity.
///
/// In some contexts it is also used to mean no instances.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems unexpected and probably needs a few more words.

The fact that InstancePathHash::None happens to specify SPLAT makes sense.

Are there other contexts where SPLAT means none?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the comment. It wasn't even correct. Even in an InstancePath, SPLAT means "all the instances of the entity".

@jleibs
Copy link
Member

jleibs commented Jan 31, 2023

Also, agree with the proposed rename Instance -> InstanceId or InstanceKey (which is the other thing we refer to is as).

@emilk emilk merged commit dc1769d into main Jan 31, 2023
@emilk emilk deleted the emilk/refactor-instance-id branch January 31, 2023 05:20
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.

None yet

2 participants