Comments on descriptions.lua

mods/ITEMS/mcl_copper/descriptions.lua

@@ -1,5 +1,6 @@
 local S = minetest.get_translator("mcl_copper")
-
+-- Copper-related blocks descriptions, indexed by its names and selected by its position on the
+-- oxidation chain.
 mcl_copper.copper_descs = {
     ["block"] = {
         S("Block of Copper"), S("Waxed Block of Copper"),
@@ -62,7 +63,8 @@ mcl_copper.copper_descs = {
         S("Waxed Oxidized Copper Bulb").." "..S("(Lit and Powered)")
     }
 }
-
+-- All longdescs for copper-related blocks. Waxed variants share the same description with its unwaxed
+-- variant. Like the descriptions, they are indexed by the block name.
 mcl_copper.copper_longdescs = {
     ["block"] = {
         S("A block of copper is mostly a decorative block."),
@@ -113,7 +115,7 @@ mcl_copper.copper_longdescs = {
         S("Oxidized copper bulb is a decorative block and a light source.")
     }
 }
-
+-- Subnames for copper stairs and slabs. For now, just indexed for the cut copper blocks.
 mcl_copper.stairs_subnames = {
     ["cut"] = {
         "copper_cut", "waxed_copper_cut",
@@ -122,7 +124,7 @@ mcl_copper.stairs_subnames = {
         "copper_oxidized_cut", "waxed_copper_oxidized_cut"
     }
 }
-
+-- Descriptions for the mcl_stairs blocks. Indexed by the name of oxidation stage of its material.
 mcl_copper.stairs_descs = {
     ["copper_cut"] = {
         S("Slab of Cut Copper"),
@@ -165,7 +167,8 @@ mcl_copper.stairs_descs = {
         S("Waxed Stairs of Oxidized Cut Copper")
     }
 }
-
+-- Description for the mcl_doors blocks. Selected by its position on the inner table.
+-- {door_description, trapdoor_description}.
 mcl_copper.doors_descs = {
     {S("Copper Door"), S("Copper Trapdoor")},
     {S("Waxed Copper Door"), S("Waxed Copper Trapdoor")},