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

Use <url> for links in python docs #7325

Merged
merged 6 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ lod = "lod" # level-of-detail
ND = "ND" # np.NDArray
somes = "somes" # many `Some`
teh = "teh" # part of @teh-cmc
trak = "trak" # mp4 crate spelling

# Use the more common spelling
adaptor = "adapter"
Expand Down
2 changes: 1 addition & 1 deletion crates/build/re_types_builder/src/codegen/python/views.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ should be applied. The value is a list of component or component batches to appl

Important note: the path must be a fully qualified entity path starting at the root. The override paths
do not yet support `$origin` relative paths or glob expressions.
This will be addressed in: [https://github.com/rerun-io/rerun/issues/6673][].".to_owned(),)
This will be addressed in <https://github.com/rerun-io/rerun/issues/6673>.".to_owned(),)
];
for field in &obj.fields {
let doc_content = field.docs.lines_for(objects, Target::Python);
Expand Down
2 changes: 1 addition & 1 deletion crates/store/re_chunk/src/batcher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ fn batching_thread(config: ChunkBatcherConfig, rx_cmd: Receiver<Command>, tx_chu
);

// Set to `true` when a flush is triggered for a reason other than hitting the time threshold,
// so that the next tick will not unncessarily fire early.
// so that the next tick will not unnecessarily fire early.
let mut skip_next_tick = false;

use crossbeam::select;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace rerun.archetypes;
///
/// \py It's not currently possible to use `send_columns` with tensors since construction
/// \py of `rerun.components.TensorDataBatch` does not support more than a single element.
/// \py This will be addressed as part of https://github.com/rerun-io/rerun/issues/6832.
/// \py This will be addressed as part of <https://github.com/rerun-io/rerun/issues/6832>.
///
/// \example archetypes/tensor_simple title="Simple tensor" image="https://static.rerun.io/tensor_simple/baacb07712f7b706e3c80e696f70616c6c20b367/1200w.png"
table Tensor (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace rerun.datatypes;
///
/// \py It's not currently possible to use `send_columns` with tensors since construction
/// \py of `rerun.components.TensorDataBatch` does not support more than a single element.
/// \py This will be addressed as part of https://github.com/rerun-io/rerun/issues/6832.
/// \py This will be addressed as part of <https://github.com/rerun-io/rerun/issues/6832>.
table TensorData (
"attr.python.aliases": "npt.ArrayLike",
"attr.python.array_aliases": "npt.ArrayLike",
Expand Down
2 changes: 1 addition & 1 deletion examples/python/controlnet/controlnet.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"""
Example running ControlNet conditioned on Canny edges.

Based on https://huggingface.co/docs/diffusers/using-diffusers/controlnet.
Based on <https://huggingface.co/docs/diffusers/using-diffusers/controlnet>.
"""

from __future__ import annotations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"""
Example running Depth Guided Stable Diffusion 2.0.

For more info see: https://github.com/Stability-AI/stablediffusion
For more info see <https://github.com/Stability-AI/stablediffusion>
"""

from __future__ import annotations
Expand Down
4 changes: 2 additions & 2 deletions examples/python/face_tracking/face_tracking.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class FaceDetectorLogger:
"""
Logger for the MediaPipe Face Detection solution.

https://developers.google.com/mediapipe/solutions/vision/face_detector
<https://developers.google.com/mediapipe/solutions/vision/face_detector>
"""

MODEL_PATH: Final = (MODEL_DIR / "blaze_face_short_range.tflite").resolve()
Expand Down Expand Up @@ -158,7 +158,7 @@ class FaceLandmarkerLogger:
"""
Logger for the MediaPipe Face Landmark Detection solution.

https://developers.google.com/mediapipe/solutions/vision/face_landmarker
<https://developers.google.com/mediapipe/solutions/vision/face_landmarker>
"""

MODEL_PATH: Final = (MODEL_DIR / "face_landmarker.task").resolve()
Expand Down
2 changes: 1 addition & 1 deletion examples/python/gesture_detection/gesture_detection.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class GestureDetectorLogger:
This class provides logging and utility functions for handling gesture recognition.

For more information on MediaPipe Gesture Detection:
https://developers.google.com/mediapipe/solutions/vision/gesture_recognizer
<https://developers.google.com/mediapipe/solutions/vision/gesture_recognizer>
"""

# URL to the pre-trained MediaPipe Gesture Detection model
Expand Down
2 changes: 1 addition & 1 deletion examples/python/lidar/lidar/download_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def download_minisplit(root_dir: pathlib.Path) -> None:
"""
Download nuScenes minisplit.

Adopted from https://colab.research.google.com/github/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/nuscenes_tutorial.ipynb
Adopted from <https://colab.research.google.com/github/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/nuscenes_tutorial.ipynb>
"""
zip_file_path = pathlib.Path("./v1.0-mini.tgz")
if not zip_file_path.is_file():
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def download_minisplit(root_dir: pathlib.Path) -> None:
"""
Download nuScenes minisplit.

Adopted from https://colab.research.google.com/github/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/nuscenes_tutorial.ipynb
Adopted from <https://colab.research.google.com/github/nutonomy/nuscenes-devkit/blob/master/python-sdk/tutorials/nuscenes_tutorial.ipynb>
"""
zip_file_path = pathlib.Path("./v1.0-mini.tgz")
if not zip_file_path.is_file():
Expand Down
2 changes: 1 addition & 1 deletion examples/python/rgbd/rgbd.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ def download_progress(url: str, dst: Path) -> None:
"""
Download file with tqdm progress bar.

From: https://gist.github.com/yanqd0/c13ed29e29432e3cf3e7c38467f42f51
From: <https://gist.github.com/yanqd0/c13ed29e29432e3cf3e7c38467f42f51>
"""
resp = requests.get(url, stream=True)
if resp.status_code != 200:
Expand Down
2 changes: 1 addition & 1 deletion examples/python/ros_node/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The solution here is mostly a toy example to show how ROS concepts can be
mapped to Rerun. Fore more information on future improved ROS support,
see the tracking issue: https://github.com/rerun-io/rerun/issues/1537
see the tracking issue: <https://github.com/rerun-io/rerun/issues/1537>.

NOTE: Unlike many of the other examples, this example requires a system installation of ROS
in addition to the packages from requirements.txt.
Expand Down
2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/_baseclasses.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class AsComponents(Protocol):

Note: the `num_instances()` function is an optional part of this interface. The method does not need to be
implemented as it is only used after checking for its existence. (There is unfortunately no way to express this
correctly with the Python typing system, see https://github.com/python/typing/issues/601).
correctly with the Python typing system, see <https://github.com/python/typing/issues/601>).
"""

def as_component_batches(self) -> Iterable[ComponentBatchLike]:
Expand Down
2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/archetypes/tensor.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def __init__(

Important note: the path must be a fully qualified entity path starting at the root. The override paths
do not yet support `$origin` relative paths or glob expressions.
This will be addressed in: [https://github.com/rerun-io/rerun/issues/6673][].
This will be addressed in <https://github.com/rerun-io/rerun/issues/6673>.

"""
self.id = uuid.uuid4()
Expand Down
2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/views/bar_chart_view.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/views/spatial2d_view.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/views/spatial3d_view.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/views/tensor_view.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/blueprint/views/text_log_view.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/datatypes/tensor_data.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions rerun_py/rerun_sdk/rerun/legacy_notebook.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ def as_html(
height : int
The height of the viewer in pixels.
app_url : str
Alternative HTTP url to find the Rerun web viewer. This will default to using https://app.rerun.io
Alternative HTTP url to find the Rerun web viewer. This will default to using `https://app.rerun.io`
or localhost if [rerun.start_web_viewer_server][] has been called.
timeout_ms : int
The number of milliseconds to wait for the Rerun web viewer to load.
Expand Down Expand Up @@ -152,7 +152,7 @@ def legacy_notebook_show(
height : int
The height of the viewer in pixels.
app_url : str
Alternative HTTP url to find the Rerun web viewer. This will default to using https://app.rerun.io
Alternative HTTP url to find the Rerun web viewer. This will default to using `https://app.rerun.io`
or localhost if [rerun.start_web_viewer_server][] has been called.
timeout_ms : int
The number of milliseconds to wait for the Rerun web viewer to load.
Expand Down
2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/recording_stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ class RecordingStream:
```
WARNING: if using a RecordingStream as a context manager, yielding from a generator function
while holding the context open will leak the context and likely cause your program to send data
to the wrong stream. See: https://github.com/rerun-io/rerun/issues/6238. You can work around this
to the wrong stream. See: <https://github.com/rerun-io/rerun/issues/6238>. You can work around this
by using the [`rerun.recording_stream_generator_ctx`][] decorator.

See also: [`rerun.get_data_recording`][], [`rerun.get_global_data_recording`][],
Expand Down
2 changes: 1 addition & 1 deletion rerun_py/rerun_sdk/rerun/sinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ def serve(
The WebSocket server will buffer all log data in memory so that late connecting viewers will get all the data.
You can limit the amount of data buffered by the WebSocket server with the `server_memory_limit` argument.
Once reached, the earliest logged data will be dropped.
Note that this means that static data may be dropped if logged early (see https://github.com/rerun-io/rerun/issues/5531).
Note that this means that static data may be dropped if logged early (see <https://github.com/rerun-io/rerun/issues/5531>).

This function returns immediately.

Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/compare.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""
Compare sizes of a list of files.

This produces the format for use in https://github.com/benchmark-action/github-action-benchmark.
This produces the format for use in <https://github.com/benchmark-action/github-action-benchmark>.

Use the script:
python3 scripts/ci/compare.py --help
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/count_bytes.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""
Measure sizes of a list of files.

This produces the format for use in https://github.com/benchmark-action/github-action-benchmark.
This produces the format for use in <https://github.com/benchmark-action/github-action-benchmark>.

Use the script:
python3 scripts/ci/count_bytes.py --help
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/count_dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""
Count the total number of dependencies of a file (recursively).

This produces the format for use in https://github.com/benchmark-action/github-action-benchmark.
This produces the format for use in <https://github.com/benchmark-action/github-action-benchmark>.

Use the script:
python3 scripts/ci/count_dependencies.py -p rerun --all-features
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/dag.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class RateLimiter:

Starts at `max_tokens`, and refills one token every `refill_interval_sec / max_tokens`.

This implementation attempts to mimic https://github.com/rust-lang/crates.io/blob/e66c852d3db3f0dfafa1f9a01e7806f0b2ad1465/src/rate_limiter.rs
This implementation attempts to mimic <https://github.com/rust-lang/crates.io/blob/e66c852d3db3f0dfafa1f9a01e7806f0b2ad1465/src/rate_limiter.rs>
"""

def __init__(self, max_tokens: int, refill_interval_sec: float):
Expand Down
2 changes: 1 addition & 1 deletion scripts/ci/render_bench.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Render benchmark graphs and other tracked metrics from data in GCS.

To use this script, you must be authenticated with GCS,
see https://cloud.google.com/docs/authentication/client-libraries for more information.
see <https://cloud.google.com/docs/authentication/client-libraries> for more information.

Install dependencies:
google-cloud-storage==2.9.0
Expand Down
Loading