Minor Documentation Fixes (#206)

* change vitepress builder link location * ensure one and only one period on relevant lines * prevent empty strings crashing * change examples println to log.info * update examples * fix a handful of typos
CleanroomMC · Jul 23, 2024 · ee9c7ad · ee9c7ad
1 parent abe8bc6
commit ee9c7ad
Show file tree

Hide file tree

Showing 46 changed files with 83 additions and 77 deletions.
diff --git a/examples/postInit/actuallyadditions.groovy b/examples/postInit/actuallyadditions.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: actuallyadditions
 
-println 'mod \'actuallyadditions\' detected, running script'
+log.info 'mod \'actuallyadditions\' detected, running script'
 
 // Atomic Reconstructor:
 // The Atomic Reconstructor is a block which uses energy to convert a block or item in front of it into other items.

diff --git a/examples/postInit/advancedmortars.groovy b/examples/postInit/advancedmortars.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: advancedmortars
 
-println 'mod \'advancedmortars\' detected, running script'
+log.info 'mod \'advancedmortars\' detected, running script'
 
 // Mortar:
 // Uses any number of specific types of Mortars to convert multiple items into a single output with a possible chance

diff --git a/examples/postInit/aether_legacy.groovy b/examples/postInit/aether_legacy.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: aether_legacy
 
-println 'mod \'aether_legacy\' detected, running script'
+log.info 'mod \'aether_legacy\' detected, running script'
 
 // Accessory:
 // The Aether Accessory system.

diff --git a/examples/postInit/alchemistry.groovy b/examples/postInit/alchemistry.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: alchemistry
 
-println 'mod \'alchemistry\' detected, running script'
+log.info 'mod \'alchemistry\' detected, running script'
 
 // Atomizer:
 // Converts a non-element into its component elements.

diff --git a/examples/postInit/appliedenergistics2.groovy b/examples/postInit/appliedenergistics2.groovy
@@ -4,7 +4,7 @@
 
 import appeng.capabilities.Capabilities
 
-println 'mod \'appliedenergistics2\' detected, running script'
+log.info 'mod \'appliedenergistics2\' detected, running script'
 
 // P2P Attunement:
 // Controls using specific items, any items from a mod, or any items with a Capability to convert a P2P into a specific

diff --git a/examples/postInit/arcanearchives.groovy b/examples/postInit/arcanearchives.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: arcanearchives
 
-println 'mod \'arcanearchives\' detected, running script'
+log.info 'mod \'arcanearchives\' detected, running script'
 
 // Gem Cutting Table:
 // Converts any number of itemstacks into a single output itemstack via selecting the desired output itemstack in the GUI.

diff --git a/examples/postInit/astralsorcery.groovy b/examples/postInit/astralsorcery.groovy
@@ -5,7 +5,7 @@
 import hellfirepvp.astralsorcery.common.constellation.MoonPhase
 import net.minecraft.util.math.MathHelper
 
-println 'mod \'astralsorcery\' detected, running script'
+log.info 'mod \'astralsorcery\' detected, running script'
 
 // Chalice Interaction:
 // When two chalices containing different fluids are placed nearby, fluid may be consumed to produce an output itemstack.

diff --git a/examples/postInit/avaritia.groovy b/examples/postInit/avaritia.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: avaritia
 
-println 'mod \'avaritia\' detected, running script'
+log.info 'mod \'avaritia\' detected, running script'
 
 // Compressor:
 // Converts any number of a single item into an output itemstack.

diff --git a/examples/postInit/betterwithmods.groovy b/examples/postInit/betterwithmods.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: betterwithmods
 
-println 'mod \'betterwithmods\' detected, running script'
+log.info 'mod \'betterwithmods\' detected, running script'
 
 // Anvil Crafting:
 // Similar to a normal crafting table, but 4x4 instead.

diff --git a/examples/postInit/bloodmagic.groovy b/examples/postInit/bloodmagic.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: bloodmagic
 
-println 'mod \'bloodmagic\' detected, running script'
+log.info 'mod \'bloodmagic\' detected, running script'
 
 // Alchemy Array:
 // Converts two items into an output itemstack by using Arcane Ashes in-world. Has a configurable texture for the

diff --git a/examples/postInit/botania.groovy b/examples/postInit/botania.groovy
@@ -5,7 +5,7 @@
 import net.minecraft.potion.PotionEffect
 import net.minecraft.util.text.TextFormatting
 
-println 'mod \'botania\' detected, running script'
+log.info 'mod \'botania\' detected, running script'
 
 // Petal Apothecary:
 // Converts item inputs into an item output consuming water and a seed.
@@ -68,7 +68,7 @@ mods.botania.elven_trade.recipeBuilder()
 
 
 // Magnet:
-// Add or remove items from the magnet blacklist
+// Add or remove items from the magnet blacklist.
 
 
 mods.botania.magnet.addToBlacklist(item('minecraft:diamond'))

diff --git a/examples/postInit/calculator.groovy b/examples/postInit/calculator.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: calculator
 
-println 'mod \'calculator\' detected, running script'
+log.info 'mod \'calculator\' detected, running script'
 
 // Algorithm Separator:
 // Converts an input itemstack into two output itemstacks.

diff --git a/examples/postInit/chisel.groovy b/examples/postInit/chisel.groovy
@@ -2,10 +2,10 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: chisel
 
-println 'mod \'chisel\' detected, running script'
+log.info 'mod \'chisel\' detected, running script'
 
 // Carving:
-// Sets a group of items any item can be converted between freely, in world and in a GUI
+// Sets a group of items any item can be converted between freely, in world and in a GUI.
 
 // mods.chisel.carving.removeAll()
 mods.chisel.carving.removeGroup('blockDiamond')

diff --git a/examples/postInit/compactmachines3.groovy b/examples/postInit/compactmachines3.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: compactmachines3
 
-println 'mod \'compactmachines3\' detected, running script'
+log.info 'mod \'compactmachines3\' detected, running script'
 
 // Miniaturization:
 // Consumes a 3d structure in-world based on keys when an item is thrown into the field.

diff --git a/examples/postInit/draconicevolution.groovy b/examples/postInit/draconicevolution.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: draconicevolution
 
-println 'mod \'draconicevolution\' detected, running script'
+log.info 'mod \'draconicevolution\' detected, running script'
 
 // Energy Core:
 // A multiblock with 8 tiers for storing large amounts of energy.

diff --git a/examples/postInit/enderio.groovy b/examples/postInit/enderio.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: enderio
 
-println 'mod \'enderio\' detected, running script'
+log.info 'mod \'enderio\' detected, running script'
 
 // Alloy Smelter:
 // Convert up to 3 itemstack inputs into an itemstack output, using energy and giving XP. Can be restricted to require a

diff --git a/examples/postInit/essentialcraft.groovy b/examples/postInit/essentialcraft.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: essentialcraft
 
-println 'mod \'essentialcraft\' detected, running script'
+log.info 'mod \'essentialcraft\' detected, running script'
 
 // Demon Trade:
 // Adds an item that can be sold to Demons to obtain Ackronite. Note that each demon that spawns has a random item that it

diff --git a/examples/postInit/evilcraft.groovy b/examples/postInit/evilcraft.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: evilcraft
 
-println 'mod \'evilcraft\' detected, running script'
+log.info 'mod \'evilcraft\' detected, running script'
 
 // Blood Infuser:
 // Consumes an item, some fluid, and requires a given tier of Promise of Tenacity to produce the output and some experience

diff --git a/examples/postInit/extendedcrafting.groovy b/examples/postInit/extendedcrafting.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: extendedcrafting
 
-println 'mod \'extendedcrafting\' detected, running script'
+log.info 'mod \'extendedcrafting\' detected, running script'
 
 // Combination Crafting:
 // Converts one main item and any number of additional items into an output itemstack, with a configurable rf cost and

diff --git a/examples/postInit/extrautils2.groovy b/examples/postInit/extrautils2.groovy
@@ -5,7 +5,7 @@
 import com.rwtema.extrautils2.power.IWorldPowerMultiplier
 import com.rwtema.extrautils2.tile.TilePassiveGenerator
 
-println 'mod \'extrautils2\' detected, running script'
+log.info 'mod \'extrautils2\' detected, running script'
 
 // Crusher:
 // Converts an input itemstack into an output itemstack with a chance of an additional itemstack output, consuming energy.
@@ -98,7 +98,7 @@ mods.extrautils2.generator.recipeBuilder()
 
 
 // Grid Power Generators:
-// Passively produces Grid Power into the Owner's GP network
+// Passively produces Grid Power into the Owner's GP network.
 
 mods.extrautils2.grid_power_passive_generator.setBasePower(resource('generators:creative'), 5f)
 mods.extrautils2.grid_power_passive_generator.setBasePower(resource('generators:player_wind_up'), 100f)

diff --git a/examples/postInit/immersiveengineering.groovy b/examples/postInit/immersiveengineering.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: immersiveengineering
 
-println 'mod \'immersiveengineering\' detected, running script'
+log.info 'mod \'immersiveengineering\' detected, running script'
 
 // Alloy Kiln:
 // Converts two input itemstacks into an output itemstack, consuming fuel (based on burn time).

diff --git a/examples/postInit/immersivepetroleum.groovy b/examples/postInit/immersivepetroleum.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: immersivepetroleum
 
-println 'mod \'immersivepetroleum\' detected, running script'
+log.info 'mod \'immersivepetroleum\' detected, running script'
 
 // Distillation Tower:
 // Converts an input fluidstack into any number of output fluidstacks and any number of output itemstacks, with each

diff --git a/examples/postInit/industrialforegoing.groovy b/examples/postInit/industrialforegoing.groovy
@@ -4,7 +4,7 @@
 
 import net.minecraft.potion.PotionEffect
 
-println 'mod \'industrialforegoing\' detected, running script'
+log.info 'mod \'industrialforegoing\' detected, running script'
 
 // Bioreactor:
 // Converts an input item into Biofuel, with the amount of Biofuel generated being based on the number of concurrent

diff --git a/examples/postInit/inspirations.groovy b/examples/postInit/inspirations.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: inspirations
 
-println 'mod \'inspirations\' detected, running script'
+log.info 'mod \'inspirations\' detected, running script'
 
 // Anvil Smashing:
 // Converts a Block or IBlockState into an IBlockState when an anvil falls on top of it (from any height).

diff --git a/examples/postInit/integrateddynamics.groovy b/examples/postInit/integrateddynamics.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: integrateddynamics
 
-println 'mod \'integrateddynamics\' detected, running script'
+log.info 'mod \'integrateddynamics\' detected, running script'
 
 // Drying Basin:
 // Takes either an item or fluid input and gives either an item or fluid output after a duration.

diff --git a/examples/postInit/jei.groovy b/examples/postInit/jei.groovy
@@ -4,10 +4,10 @@
 
 import mezz.jei.api.ingredients.VanillaTypes
 
-println 'mod \'jei\' detected, running script'
+log.info 'mod \'jei\' detected, running script'
 
 // Category Catalysts:
-// Modify the items shown on the left of JEI Categories which indicate where the recipe takes place
+// Modify the items shown on the left of JEI Categories which indicate where the recipe takes place.
 
 mods.jei.catalyst.remove('minecraft.smelting', item('minecraft:furnace'))
 // mods.jei.catalyst.removeByType('minecraft.anvil')

diff --git a/examples/postInit/mekanism.groovy b/examples/postInit/mekanism.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: mekanism
 
-println 'mod \'mekanism\' detected, running script'
+log.info 'mod \'mekanism\' detected, running script'
 
 // Infusion:
 // Add new infusion types and itemstacks to those types.

diff --git a/examples/postInit/naturesaura.groovy b/examples/postInit/naturesaura.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: naturesaura
 
-println 'mod \'naturesaura\' detected, running script'
+log.info 'mod \'naturesaura\' detected, running script'
 
 // Natural Altar Infusion:
 // Converts an input itemstack into an itemstack in a multiblock structure, with an optional catalyst block, costing aura

diff --git a/examples/postInit/pneumaticcraft.groovy b/examples/postInit/pneumaticcraft.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: pneumaticcraft
 
-println 'mod \'pneumaticcraft\' detected, running script'
+log.info 'mod \'pneumaticcraft\' detected, running script'
 
 // Amadron:
 // Uses an Amadron Tablet and linked inventories in world to trade via drones.

diff --git a/examples/postInit/prodigytech.groovy b/examples/postInit/prodigytech.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: prodigytech
 
-println 'mod \'prodigytech\' detected, running script'
+log.info 'mod \'prodigytech\' detected, running script'
 
 // Atomic Reshaper:
 // Uses Hot Air and Primordium to convert items. Can have a weighted random based output.

diff --git a/examples/postInit/projecte.groovy b/examples/postInit/projecte.groovy
@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: projecte
 
-println 'mod \'projecte\' detected, running script'
+log.info 'mod \'projecte\' detected, running script'
 
 // Entity Randomizer:
 // Converts an entity on the list into a random other entity on the list when a projectile fired from the Philosopher's