From 10797f0d5fede505efc1446c39a38850312a1152 Mon Sep 17 00:00:00 2001 From: teknomunk Date: Tue, 6 Aug 2024 18:56:00 -0500 Subject: [PATCH] Correct documentation per review --- mods/CORE/vl_legacy/API.md | 6 +++--- mods/ENTITIES/mcl_minecarts/API.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/mods/CORE/vl_legacy/API.md b/mods/CORE/vl_legacy/API.md index 4bbc4658e..7c1dde2e7 100644 --- a/mods/CORE/vl_legacy/API.md +++ b/mods/CORE/vl_legacy/API.md @@ -1,15 +1,15 @@ # Legacy Code Support Functions -## vl\_legacy.deprecated(description, replacement) +## `vl_legacy.deprecated(description, replacement)` -Creates a wrapper than logs calls to deprecated function. +Creates a wrapper that logs calls to deprecated function. Arguments: * `description`: The text logged when the deprecated function is called. * `replacement`: The function that should be called instead. This is invoked passing along the parameters exactly as provided. -## vl\_legacy.register\_item\_conversion +## `vl_legacy.register_item_conversion` Allows automatic conversion of items. diff --git a/mods/ENTITIES/mcl_minecarts/API.md b/mods/ENTITIES/mcl_minecarts/API.md index a315beb32..e628e0d59 100644 --- a/mods/ENTITIES/mcl_minecarts/API.md +++ b/mods/ENTITIES/mcl_minecarts/API.md @@ -46,7 +46,7 @@ Where to attach passengers to the minecarts. `mcl_minecarts.HORIZONTAL_CURVES_RULES` `mcl_minecarts.HORIZONTAL_STANDARD_RULES` -Rail connection rules. Each rule is an table with the following indexes: +Rail connection rules. Each rule is a table with the following indexes: 1. `node_name_suffix` - The suffix added to a node's `_mcl_minecarts.base_name` to get the name of the node to use for this connection. @@ -167,7 +167,7 @@ Force a minecart to start moving in the opposite direction of its current direct Returns a valid cart movement direction that has the smallest angle between it and `direction_vector`. -`mcl_minecarts:update_cart_orientation(cart)` +`mcl_minecarts.update_cart_orientation(cart)` Updates the rotation of a cart entity to match the cart's data.