Skip to content

Commit

Permalink
Don't use Title Casing for "entity" (#6473)
Browse files Browse the repository at this point in the history
* [x] ok
  • Loading branch information
emilk authored Jun 3, 2024
1 parent ee80b7b commit 2a2f9d5
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion crates/re_data_store/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Part of the [`rerun`](https://github.com/rerun-io/rerun) family of crates.

[Apache Arrow](https://arrow.apache.org/) is a language-independent columnar memory format for arbitrary data.

The `re_data_store` crate is an in-memory time series database for Rerun log data. It is indexed by Entity path, component, timeline, and time. It supports out-of-order insertions, and fast `O(log(N))` queries.
The `re_data_store` crate is an in-memory time series database for Rerun log data. It is indexed by entity path, component, timeline, and time. It supports out-of-order insertions, and fast `O(log(N))` queries.
2 changes: 1 addition & 1 deletion crates/re_data_store/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! using the [`arrow2`] crate.
//!
//! This crate is an in-memory time series database for Rerun log data.
//! It is indexed by Entity path, component, timeline, and time.
//! It is indexed by entity path, component, timeline, and time.
//! It supports out-of-order insertions, and fast `O(log(N))` queries.
//!
//! * See [`DataStore`] for an overview of the core data structures.
Expand Down
4 changes: 2 additions & 2 deletions crates/re_selection_panel/src/query_range_ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ fn query_range_ui(
.on_hover_text(if is_space_view {
"Default query range settings for this kind of space view"
} else {
"Query range settings inherited from parent Entity or enclosing \
"Query range settings inherited from parent entity or enclosing \
space view"
});
re_ui
Expand Down Expand Up @@ -269,7 +269,7 @@ fn query_range_ui(
let markdown = format!("# Visible time range\n
This feature controls the time range used to display data in the space view.
The settings are inherited from the parent Entity or enclosing space view if not overridden.
The settings are inherited from the parent entity or enclosing space view if not overridden.
Visible time range properties are stored separately for each _type_ of timelines. They may differ depending on \
whether the current timeline is temporal or a sequence. The current settings apply to all _{}_ timelines.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/data-in/cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ You're looking at one of these dedicated features right now in fact: notice how
---

A _lot_ is happening in these two simple function calls.
Good news is: once you've digested all of the above, logging any other Entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.
Good news is: once you've digested all of the above, logging any other entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.

## Adding the missing pieces

Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/data-in/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ You're looking at one of these dedicated features right now in fact: notice how
---

A _lot_ is happening in these two simple function calls.
Good news is: once you've digested all of the above, logging any other Entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.
Good news is: once you've digested all of the above, logging any other entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.

## Adding the missing pieces

Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/data-in/rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ You're looking at one of these dedicated features right now in fact: notice how
---

A _lot_ is happening in these two simple function calls.
Good news is: once you've digested all of the above, logging any other Entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.
Good news is: once you've digested all of the above, logging any other entity will simply be more of the same. In fact, let's go ahead and log everything else in the scene now.

## Adding the missing pieces

Expand Down
20 changes: 10 additions & 10 deletions docs/content/reference/viewer/blueprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ order: 1

The blueprint is how you configure what is displayed in the Rerun viewer.
It is saved between sessions and is unique to a given [application id](../../concepts/apps-and-recordings.md).
The Blueprint includes all Space View configurations, Entity groupings and Entity settings, also known as Data Blueprints.
The blueprint includes all space view configurations, entity groupings and entity settings, also known as _data blueprints_.

This view shows the Blueprint for the active recording.
This view shows the blueprint for the active recording.
Everything visible in the [Viewport](viewport.md) has a representation here,
making it an easy way to select a Space View and the [Entities](../../concepts/entity-component.md) it shows.

Expand All @@ -20,8 +20,8 @@ making it an easy way to select a Space View and the [Entities](../../concepts/e
Controls
--------
### Reset
The reset button resets the entire Blueprint back to its heuristic-chosen default.
This includes all settings for Entities, Groups and Space Views.
The reset button resets the entire blueprint back to its heuristic-chosen default.
This includes all settings for entities, Groups and Space Views.

### Add space view
With this control you can add new Space Views for arbitrary [Spaces](../../concepts/spaces-and-transforms.md).
Expand All @@ -31,21 +31,21 @@ Contents
Upon hovering any line in the Blueprint panel, you'll find shorthands for removing and hide/show.

### Data blueprints
All Entities shown in the blueprint panel refer in fact to their Data Blueprints.
All entities shown in the blueprint panel refer in fact to their Data Blueprints.
I.e. the entity plus the associated blueprint settings.
As such, all changes made here are only relevant for the Space View in which they reside.

### Groups
Whenever Entities are added to a Space View (either manually or automatically), groupings
Whenever entities are added to a space view (either manually or automatically), groupings
are automatically created.
Groups, despite being derived from the [Entity Path](../../concepts/entity-path.md) are independent of logged data.
They are meant to improve the handling of large Space Views and allow for hierarchical manipulation
They are meant to improve the handling of large space views and allow for hierarchical manipulation
of blueprints.

Adding Entities
-----------------------------
To (re-)add an Entity to a Space View, you need first need to select the respective Space View.
To (re-)add an entity to a space view, you need first need to select the respective space view.
You then can open a dedicated menu through a button in the [Selection view](selection.md).

This allows you to add any Entity with a matching [category](viewport.md#space-view-classes) and a valid [transform](../../concepts/spaces-and-transforms.md) to your
Space View's path.
This allows you to add any entity with a matching [category](viewport.md#space-view-classes) and a valid [transform](../../concepts/spaces-and-transforms.md) to your
space view's path.
2 changes: 1 addition & 1 deletion docs/content/reference/viewer/selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The data section always shows static, raw user logged data for the currently sel
Some objects, e.g. Space Views, may not have a data section and expose only Blueprint options.

In contrast, the Blueprint section is timeline independent and exposes the
[Blueprint settings](blueprint.md) of an Entity in the context of a given Space View.
[Blueprint settings](blueprint.md) of an entity in the context of a given Space View.
To learn more about the various settings check the on-hover tooltips.

Click-through selections
Expand Down
6 changes: 3 additions & 3 deletions docs/content/reference/viewer/timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ You can use the mouse to scrub the vertical time selector line to jump to arbitr
The stream view allows panning with right click and zooming with `ctrl/cmd + scroll`.


The tree on the left shows you all Entities that were logged for this timeline.
When you expand an Entity you will see both the Components that are associated with it, as well as any child Entities.
Selecting Entities or Events in the Streams view shows additional information in the Selection panel about them respectively.
The tree on the left shows you all entities that were logged for this timeline.
When you expand an entity you will see both the components that are associated with it, as well as any child entities.
Selecting entities or events in the streams view shows additional information in the selection panel about them respectively.

### Discontinuity skipping
Rerun automatically detects discontinuities in the selected timeline and will skip over them while playing.
Expand Down

0 comments on commit 2a2f9d5

Please sign in to comment.