aboutsummaryrefslogtreecommitdiff
path: root/azalea-client
diff options
context:
space:
mode:
authormat <git@matdoes.dev>2025-12-15 14:59:26 +0700
committermat <git@matdoes.dev>2025-12-15 14:59:26 +0700
commit0569ffd2d85585eb69de9068ab3f62e768bce4e7 (patch)
treee20d7faf8df7ede4eb3f52d3223b27782a964be0 /azalea-client
parent232f1a434406d77dc5ef1d19edcdf006e32491e8 (diff)
downloadazalea-drasl-0569ffd2d85585eb69de9068ab3f62e768bce4e7.tar.xz
write/update docs for several items
Diffstat (limited to 'azalea-client')
-rw-r--r--azalea-client/README.md2
-rw-r--r--azalea-client/src/client.rs4
-rw-r--r--azalea-client/src/lib.rs8
3 files changed, 4 insertions, 10 deletions
diff --git a/azalea-client/README.md b/azalea-client/README.md
index 6ec41a0c..73ef1769 100644
--- a/azalea-client/README.md
+++ b/azalea-client/README.md
@@ -2,4 +2,4 @@
A library that can mimic everything that a normal Minecraft client can do.
-If you want to make a bot with higher-level functions, consider using the `azalea` crate instead.
+To make a bot with higher-level functions, consider using the `azalea` crate instead.
diff --git a/azalea-client/src/client.rs b/azalea-client/src/client.rs
index 3ba52395..598c9ed4 100644
--- a/azalea-client/src/client.rs
+++ b/azalea-client/src/client.rs
@@ -492,7 +492,7 @@ impl Client {
///
/// This is necessary for data-driven registries like [`Enchantment`].
///
- /// [`Enchantment`]: azalea_registry::Enchantment
+ /// [`Enchantment`]: azalea_registry::data::Enchantment
pub fn resolve_registry_name(
&self,
registry: &impl ResolvableDataRegistry,
@@ -507,7 +507,7 @@ impl Client {
/// If you just want the value name, use [`Self::resolve_registry_name`]
/// instead.
///
- /// [`Enchantment`]: azalea_registry::Enchantment
+ /// [`Enchantment`]: azalea_registry::data::Enchantment
pub fn with_resolved_registry<R: ResolvableDataRegistry, Ret>(
&self,
registry: R,
diff --git a/azalea-client/src/lib.rs b/azalea-client/src/lib.rs
index 6d216b2b..cff0b03a 100644
--- a/azalea-client/src/lib.rs
+++ b/azalea-client/src/lib.rs
@@ -1,10 +1,4 @@
-//! Significantly abstract [`azalea_protocol`] so it's actually useable for
-//! real clients. If you want to make bots, you should use the
-//! [`azalea`] crate instead.
-//!
-//! [`azalea_protocol`]: https://docs.rs/azalea-protocol
-//! [`azalea`]: https://docs.rs/azalea
-
+#![doc = include_str!("../README.md")]
#![feature(error_generic_member_access)]
#![feature(never_type)]