Improve docs (fixes #15)

phoenixr-codes · Nov 26, 2024 · 1726f46 · 1726f46
1 parent 35018bb
commit 1726f46
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,6 +29,9 @@ keywords = [
 ]
 
 [project.optional-dependencies]
+dev = [
+  "pytest>=8"
+]
 docs = [
     "furo",
     "myst-parser>=2",

diff --git a/src/mcstructure/__init__.py b/src/mcstructure/__init__.py
@@ -38,7 +38,8 @@
 STRUCTURE_MAX_SIZE: tuple[int, int, int] = (64, 384, 64)
 """
 The maximum size a structure can have. This does not apply for
-structures created externally.
+structures created externally and thus is not affect structures
+created with this library.
 """
 
 
@@ -129,7 +130,7 @@ class Block:
     --------
     .. code-block::
 
-        Block("minecraft:wool", color="red")
+        Block("minecraft:beehive", honey_level=4)
         Block("minecraft:grass")
 
     """