From c5ddae58a172289fffde991830bb79860421a961 Mon Sep 17 00:00:00 2001
From: mat <git@matdoes.dev>
Date: Mon, 2 Jun 2025 11:51:03 -0600
Subject: improve docs for biome code

---
 azalea-registry/src/data.rs | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'azalea-registry/src')

diff --git a/azalea-registry/src/data.rs b/azalea-registry/src/data.rs
index 91e7106f..011835ed 100644
--- a/azalea-registry/src/data.rs
+++ b/azalea-registry/src/data.rs
@@ -24,7 +24,8 @@ impl<T: DataRegistry> Registry for T {
 }
 
 macro_rules! data_registry {
-    ($name:ident, $registry_name:expr) => {
+    ($(#[$doc:meta])* $name:ident, $registry_name:expr) => {
+        $(#[$doc])*
         #[derive(Debug, Clone, Copy, AzBuf, PartialEq, Eq, Hash)]
         pub struct $name {
             #[var]
@@ -54,7 +55,15 @@ data_registry! {PigVariant, "pig_variant"}
 data_registry! {PaintingVariant, "painting_variant"}
 data_registry! {WolfVariant, "wolf_variant"}
 
-data_registry! {Biome, "biome"}
+data_registry! {
+    /// An opaque biome identifier.
+    ///
+    /// You'll probably want to resolve this into its name before using it, by
+    /// using `Client::with_resolved_registry` or a similar function.
+    Biome,
+    "worldgen/biome"
+}
+
 // these extra traits are required for Biome to be allowed to be palletable
 impl Default for Biome {
     fn default() -> Self {
-- 
cgit v1.2.3