Skip to content

Commit e4c2608

Browse files
jleibsWumpf
andauthored
Fix inconsistent comments in code examples (#3965)
### What Mostly copy-paste errors. ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3965) (if applicable) * [x] The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG - [PR Build Summary](https://build.rerun.io/pr/3965) - [Docs preview](https://rerun.io/preview/8a9175da0e35702cd337fb543b349ec37a26fd0e/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/8a9175da0e35702cd337fb543b349ec37a26fd0e/examples) <!--EXAMPLES-PREVIEW--> - [Recent benchmark results](https://ref.rerun.io/dev/bench/) - [Wasm size tracking](https://ref.rerun.io/dev/sizes/) --------- Co-authored-by: Andreas Reich <[email protected]>
1 parent 8e57f41 commit e4c2608

15 files changed

+16
-14
lines changed

docs/code-examples/asset3d_simple.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log a batch of 3D arrows.
1+
// Log a a simple 3D asset.
22

33
#include <rerun.hpp>
44

docs/code-examples/bar_chart.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log a batch of 3D arrows.
1+
// Create and log a bar chart.
22

33
#include <rerun.hpp>
44

docs/code-examples/clear_recursive.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log a batch of 3D arrows.
1+
// Log and then clear data recursively.
22

33
#include <rerun.hpp>
44

docs/code-examples/clear_recursive.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Log a batch of 3D arrows."""
1+
"""Log and then clear data recursively."""
22

33
import rerun as rr
44

docs/code-examples/clear_recursive.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Log a batch of 3D arrows.
1+
//! Log and then clear data recursively.
22
33
use rerun::external::glam;
44

docs/code-examples/clear_simple.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log a batch of 3D arrows.
1+
// Log and then clear data.
22

33
#include <rerun.hpp>
44

docs/code-examples/clear_simple.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Log a batch of 3D arrows."""
1+
"""Log and then clear data."""
22

33
import rerun as rr
44

docs/code-examples/clear_simple.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Log a batch of 3D arrows.
1+
//! Log and then clear data.
22
33
use rerun::external::glam;
44

docs/code-examples/depth_image_3d.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Create and log a depth image.
1+
// Create and log a depth image and pinhole camera.
22

33
#include <rerun.hpp>
44

docs/code-examples/disconnected_space.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Log some very simple points."""
1+
"""Disconnect two spaces."""
22
import rerun as rr
33

44
rr.init("rerun_example_disconnect_space", spawn=True)

docs/code-examples/line_segments2d_simple.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Log a simple set of line segments."""
1+
"""Log a couple 2D line segments using 2D line strips."""
22
import numpy as np
33
import rerun as rr
44

docs/code-examples/point2d_random.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log some very simple points.
1+
// Log some random points with color and radii.
22

33
#include <rerun.hpp>
44

docs/code-examples/scalar_simple.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Log a scalar over time.
2+
13
#include <rerun.hpp>
24

35
#include <cmath>

docs/code-examples/transform3d_simple.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Log some transforms.
1+
// Log different transforms between three arrows.
22

33
#include <rerun.hpp>
44

docs/code-examples/transform3d_simple.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Log some transforms.
1+
//! Log different transforms between three arrows.
22
33
use std::f32::consts::TAU;
44

0 commit comments

Comments
 (0)