Skip to content

Commit

Permalink
Fix UiCameraConfig doc (link to the Camera page) (bevyengine#6969)
Browse files Browse the repository at this point in the history
The Camera link in the UiCameraConfig was not rendered properly by the documentation.

# Objective

- In the UiCameraConfig page (https://docs.rs/bevy/latest/bevy/prelude/struct.UiCameraConfig.html), a link to the Camera page (https://docs.rs/bevy/latest/bevy/render/camera/struct.Camera.html) is broken.

## Solution

- It seems that when using URL fragment specifiers, backtick should not be used. It might be an issue of rust itself. Replacing the URL fragment specifier `[`Camera`]: bevy_render::camera::Camera` with `[Camera]: bevy_render::camera::Camera` solves this.
  • Loading branch information
redwarp authored and ItsDoot committed Feb 1, 2023
1 parent 621d123 commit 3463d13
Showing 1 changed file with 0 additions and 1 deletion.
1 change: 0 additions & 1 deletion crates/bevy_ui/src/camera_config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ use bevy_render::extract_component::ExtractComponent;
/// When a [`Camera`] doesn't have the [`UiCameraConfig`] component,
/// it will display the UI by default.
///
/// [`Camera`]: bevy_render::camera::Camera
#[derive(Component, Clone)]
pub struct UiCameraConfig {
/// Whether to output UI to this camera view.
Expand Down

0 comments on commit 3463d13

Please sign in to comment.