Skip to content

Commit c61ce1f

Browse files
committed
Minor doc fixes
Links to Bevy types don't work on docs.rs. The workaround is to use actual url to docs.rs. That seems tedious and fragile, so we'll just remove the links and inser the word "Bevy" so that people know where to look. See rust-lang/docs.rs#1588
1 parent 8bdf8ca commit c61ce1f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/lib.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use bevy::{
88
text::BreakLineOn,
99
};
1010

11-
/// A `Plugin` providing the systems and assets required to make a [`TextInputBundle`] work.
11+
/// A Bevy `Plugin` providing the systems and assets required to make a [`TextInputBundle`] work.
1212
pub struct TextInputPlugin;
1313

1414
impl Plugin for TextInputPlugin {
@@ -46,7 +46,7 @@ const CURSOR_HANDLE: Handle<Font> = Handle::weak_from_u128(10482756907980398621)
4646

4747
/// A bundle providing the additional components required for a text input.
4848
///
49-
/// Add this to a [`NodeBundle`].
49+
/// Add this to a Bevy `NodeBundle`.
5050
///
5151
/// Examples:
5252
/// ```rust
@@ -60,7 +60,7 @@ const CURSOR_HANDLE: Handle<Font> = Handle::weak_from_u128(10482756907980398621)
6060
pub struct TextInputBundle {
6161
/// A component containing the text input's settings.
6262
pub settings: TextInputSettings,
63-
/// A component containing the [`TextStyle`] that will be used when creating the text input's inner [`TextBundle`].
63+
/// A component containing the Bevy `TextStyle` that will be used when creating the text input's inner Bevy `TextBundle`.
6464
pub text_style: TextInputTextStyle,
6565
/// A component containing a value indicating whether the text input is active or not.
6666
pub inactive: TextInputInactive,
@@ -87,7 +87,7 @@ impl TextInputBundle {
8787
self
8888
}
8989

90-
/// Returns this [`TextInputBundle`] with a new [`TextInputTextStyle`] containing the provided `TextStyle`.
90+
/// Returns this [`TextInputBundle`] with a new [`TextInputTextStyle`] containing the provided Bevy `TextStyle`.
9191
pub fn with_text_style(mut self, text_style: TextStyle) -> Self {
9292
self.text_style = TextInputTextStyle(text_style);
9393
self
@@ -106,7 +106,7 @@ impl TextInputBundle {
106106
}
107107
}
108108

109-
/// The [`TextStyle`] that will be used when creating the text input's inner [`TextBundle`].
109+
/// The Bevy `TextStyle` that will be used when creating the text input's inner Bevy `TextBundle`.
110110
#[derive(Component, Default, Reflect)]
111111
pub struct TextInputTextStyle(pub TextStyle);
112112

@@ -158,7 +158,7 @@ pub struct TextInputSubmitEvent {
158158
pub value: String,
159159
}
160160

161-
/// A convenience parameter for dealing with a [`TextInput`]'s inner [`Text`] entity.
161+
/// A convenience parameter for dealing with a text input's inner Bevy `Text` entity.
162162
#[derive(SystemParam)]
163163
struct InnerText<'w, 's> {
164164
text_query: Query<'w, 's, &'static mut Text, With<TextInputInner>>,
@@ -372,7 +372,7 @@ fn create(
372372
}
373373
}
374374

375-
// Shows or hides the cursor based on the text input's `inactive` property.
375+
// Shows or hides the cursor based on the text input's [`TextInputInactive`] property.
376376
fn show_hide_cursor(
377377
mut input_query: Query<
378378
(

0 commit comments

Comments
 (0)