Skip to content

Commit 8325a02

Browse files
committed
fix doc redundant links
1 parent 424f203 commit 8325a02

File tree

33 files changed

+84
-84
lines changed

33 files changed

+84
-84
lines changed

crates/bevy_app/src/app.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ impl App {
334334
/// initial state.
335335
///
336336
/// If you would like to control how other systems run based on the current state,
337-
/// you can emulate this behavior using the [`in_state`] [`Condition`](bevy_ecs::schedule::Condition).
337+
/// you can emulate this behavior using the [`in_state`] [`Condition`].
338338
///
339339
/// Note that you can also apply state transitions at other points in the schedule
340340
/// by adding the [`apply_state_transition`] system manually.

crates/bevy_app/src/plugin.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ pub trait Plugin: Downcast + Any + Send + Sync {
5151
std::any::type_name::<Self>()
5252
}
5353

54-
/// If the plugin can be meaningfully instantiated several times in an [`App`](crate::App),
54+
/// If the plugin can be meaningfully instantiated several times in an [`App`],
5555
/// override this method to return `false`.
5656
fn is_unique(&self) -> bool {
5757
true

crates/bevy_audio/src/audio_output.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use crate::AudioSink;
1313
///
1414
/// ## Note
1515
///
16-
/// Initializing this resource will leak [`rodio::OutputStream`](rodio::OutputStream)
16+
/// Initializing this resource will leak [`rodio::OutputStream`]
1717
/// using [`std::mem::forget`].
1818
/// This is done to avoid storing this in the struct (and making this `!Send`)
1919
/// while preventing it from dropping (to avoid halting of audio).

crates/bevy_ecs/src/change_detection.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ impl_debug!(Res<'w, T>, Resource);
535535
///
536536
/// See the [`Resource`] documentation for usage.
537537
///
538-
/// If you need a shared borrow, use [`Res`](crate::system::Res) instead.
538+
/// If you need a shared borrow, use [`Res`] instead.
539539
///
540540
/// # Panics
541541
///

crates/bevy_ecs/src/component.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ impl ComponentInfo {
266266
}
267267

268268
/// A value which uniquely identifies the type of a [`Component`] within a
269-
/// [`World`](crate::world::World).
269+
/// [`World`].
270270
///
271271
/// Each time a new `Component` type is registered within a `World` using
272272
/// [`World::init_component`](crate::world::World::init_component) or

crates/bevy_ecs/src/query/filter.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -616,10 +616,10 @@ impl_tick_filter!(
616616

617617
/// A marker trait to indicate that the filter works at an archetype level.
618618
///
619-
/// This is needed to implement [`ExactSizeIterator`](std::iter::ExactSizeIterator) for
619+
/// This is needed to implement [`ExactSizeIterator`] for
620620
/// [`QueryIter`](crate::query::QueryIter) that contains archetype-level filters.
621621
///
622-
/// The trait must only be implement for filters where its corresponding [`WorldQuery::IS_ARCHETYPAL`](crate::query::WorldQuery::IS_ARCHETYPAL)
622+
/// The trait must only be implement for filters where its corresponding [`WorldQuery::IS_ARCHETYPAL`]
623623
/// is [`prim@true`]. As such, only the [`With`] and [`Without`] filters can implement the trait.
624624
/// [Tuples](prim@tuple) and [`Or`] filters are automatically implemented with the trait only if its containing types
625625
/// also implement the same trait.

crates/bevy_ecs/src/schedule/schedule.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ impl Schedule {
274274

275275
/// Set whether the schedule applies deferred system buffers on final time or not. This is a catch-all
276276
/// in case a system uses commands but was not explicitly ordered before an instance of
277-
/// [`apply_deferred`](crate::prelude::apply_deferred). By default this
277+
/// [`apply_deferred`]. By default this
278278
/// setting is true, but may be disabled if needed.
279279
pub fn set_apply_final_deferred(&mut self, apply_final_deferred: bool) -> &mut Self {
280280
self.executor.set_apply_final_deferred(apply_final_deferred);

crates/bevy_ecs/src/system/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//!
77
//! System functions can have parameters, through which one can query and mutate Bevy ECS state.
88
//! Only types that implement [`SystemParam`] can be used, automatically fetching data from
9-
//! the [`World`](crate::world::World).
9+
//! the [`World`].
1010
//!
1111
//! System functions often look like this:
1212
//!

crates/bevy_ecs/src/world/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ impl World {
383383
}
384384
}
385385

386-
/// Returns the components of an [`Entity`](crate::entity::Entity) through [`ComponentInfo`](crate::component::ComponentInfo).
386+
/// Returns the components of an [`Entity`] through [`ComponentInfo`].
387387
#[inline]
388388
pub fn inspect_entity(&self, entity: Entity) -> Vec<&ComponentInfo> {
389389
let entity_location = self
@@ -1766,7 +1766,7 @@ impl World {
17661766
/// Iterates all component change ticks and clamps any older than [`MAX_CHANGE_AGE`](crate::change_detection::MAX_CHANGE_AGE).
17671767
/// This prevents overflow and thus prevents false positives.
17681768
///
1769-
/// **Note:** Does nothing if the [`World`] counter has not been incremented at least [`CHECK_TICK_THRESHOLD`](crate::change_detection::CHECK_TICK_THRESHOLD)
1769+
/// **Note:** Does nothing if the [`World`] counter has not been incremented at least [`CHECK_TICK_THRESHOLD`]
17701770
/// times since the previous pass.
17711771
// TODO: benchmark and optimize
17721772
pub fn check_change_ticks(&mut self) {

crates/bevy_ecs/src/world/unsafe_world_cell.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ use std::{any::TypeId, cell::UnsafeCell, fmt::Debug, marker::PhantomData};
2626
/// In rust, having a `&mut World` means that there are absolutely no other references to the safe world alive at the same time,
2727
/// without exceptions. Not even unsafe code can change this.
2828
///
29-
/// But there are situations where careful shared mutable access through a type is possible and safe. For this, rust provides the [`UnsafeCell`](std::cell::UnsafeCell)
29+
/// But there are situations where careful shared mutable access through a type is possible and safe. For this, rust provides the [`UnsafeCell`]
3030
/// escape hatch, which allows you to get a `*mut T` from a `&UnsafeCell<T>` and around which safe abstractions can be built.
3131
///
3232
/// Access to resources and components can be done uniquely using [`World::resource_mut`] and [`World::entity_mut`], and shared using [`World::resource`] and [`World::entity`].
3333
/// These methods use lifetimes to check at compile time that no aliasing rules are being broken.
3434
///
3535
/// This alone is not enough to implement bevy systems where multiple systems can access *disjoint* parts of the world concurrently. For this, bevy stores all values of
36-
/// resources and components (and [`ComponentTicks`](crate::component::ComponentTicks)) in [`UnsafeCell`](std::cell::UnsafeCell)s, and carefully validates disjoint access patterns using
36+
/// resources and components (and [`ComponentTicks`]) in [`UnsafeCell`]s, and carefully validates disjoint access patterns using
3737
/// APIs like [`System::component_access`](crate::system::System::component_access).
3838
///
3939
/// A system then can be executed using [`System::run_unsafe`](crate::system::System::run_unsafe) with a `&World` and use methods with interior mutability to access resource values.
@@ -909,7 +909,7 @@ impl<'w> UnsafeWorldCell<'w> {
909909
}
910910
}
911911

912-
/// Get an untyped pointer to a particular [`Component`](crate::component::Component) on a particular [`Entity`] in the provided [`World`](crate::world::World).
912+
/// Get an untyped pointer to a particular [`Component`] on a particular [`Entity`] in the provided [`World`].
913913
///
914914
/// # Safety
915915
/// - `location` must refer to an archetype that contains `entity`
@@ -937,7 +937,7 @@ unsafe fn get_component(
937937
}
938938
}
939939

940-
/// Get an untyped pointer to a particular [`Component`](crate::component::Component) and its [`ComponentTicks`]
940+
/// Get an untyped pointer to a particular [`Component`] and its [`ComponentTicks`]
941941
///
942942
/// # Safety
943943
/// - `location` must refer to an archetype that contains `entity`

0 commit comments

Comments
 (0)