From 79d8e1bb714ec4abfe5679613e0d01aaf7d4265a Mon Sep 17 00:00:00 2001 From: Bradley Pierce Date: Sat, 20 Jan 2024 08:31:48 -0500 Subject: [PATCH] Use Github syntax for more notes and warnings --- doc/client_lua_api.md | 14 +++++++------- doc/lua_api.md | 2 +- doc/world_format.md | 10 +++++----- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/client_lua_api.md b/doc/client_lua_api.md index 48bba7cb21..6371c29664 100644 --- a/doc/client_lua_api.md +++ b/doc/client_lua_api.md @@ -5,7 +5,7 @@ ## Introduction -> **Warning**: The client API is currently unstable, and may break/change without warning. +> [!WARNING] The client API is currently unstable, and may break/change without warning. Content and functionality can be added to Minetest by using Lua scripting in run-time loaded mods. @@ -35,7 +35,7 @@ In order to load client-side mods, the following conditions need to be satisfied 2. The client-side mod located in `$path_user/clientmods/` is added to `$path_user/clientmods/mods.conf` as `load_mod_ = true`. -> **Note**: Depending on the remote server's settings, client-side mods might not +> [!NOTE] Depending on the remote server's settings, client-side mods might not be loaded or have limited functionality. See setting `csm_restriction_flags` for reference. @@ -111,7 +111,7 @@ The main Lua script. Running this script should register everything it wants to register. Subsequent execution depends on minetest calling the registered callbacks. -> **Note**: Client mods currently can't provide textures, sounds, or models by +> [!NOTE] Client mods currently can't provide textures, sounds, or models by themselves. Any media referenced in function calls must already be loaded (provided by mods that exist on the server). @@ -147,7 +147,7 @@ The `:` prefix can also be used for maintaining backwards compatibility. # Sounds -> **Note**: Connecting sounds to objects is not implemented. +> [!NOTE] Connecting sounds to objects is not implemented. Only Ogg Vorbis files are supported. @@ -340,7 +340,7 @@ Call these functions only at load time! * Called just after mods have finished loading. * `minetest.register_on_shutdown(function())` * Called before client shutdown - > **Warning**: If the client terminates abnormally (i.e. crashes), the registered + > [!WARNING] If the client terminates abnormally (i.e. crashes), the registered callbacks **will likely not be run**. Data should be saved at semi-frequent intervals as well as on server shutdown. * `minetest.register_on_receiving_chat_message(function(message))` @@ -527,7 +527,7 @@ Call these functions only at load time! * Client joins channel `channel_name`, and creates it, if necessary. You should listen from incoming messages with `minetest.register_on_modchannel_message` call to receive incoming messages. - > **Warning**: This function is asynchronous. + > [!WARNING] This function is asynchronous. ## Particles @@ -552,7 +552,7 @@ Call these functions only at load time! * Convert a Lua table into a JSON string * styled: Outputs in a human-readable format if this is set, defaults to false * Unserializable things like functions and userdata are saved as null. - > **Warning**: JSON is more strict than the Lua table format. + > [!WARNING] JSON is more strict than the Lua table format. > 1. You can only use strings and positive integers of at least one as keys. > 2. You cannot mix string and integer keys. This is due to the fact that JSON has > two distinct array and object values. diff --git a/doc/lua_api.md b/doc/lua_api.md index 071218adf3..a6eec8225c 100644 --- a/doc/lua_api.md +++ b/doc/lua_api.md @@ -7614,7 +7614,7 @@ child will follow movement and rotation of that bone. (for nodes with `liquid_move_physics`); the higher this value, the lower the resistance to movement. At `math.huge`, the resistance is zero and you can move through any liquid like air. (default: `1`) - * Warning: Values below 1 are currently unsupported. + > [!WARNING] Values below 1 are currently unsupported. * `liquid_fluidity_smooth`: multiplier to default maximum liquid resistance value (for nodes with `liquid_move_physics`); controls deceleration when entering node at high speed. At higher values you come to a halt more quickly diff --git a/doc/world_format.md b/doc/world_format.md index b5a2a3cfa3..7890a69c5f 100644 --- a/doc/world_format.md +++ b/doc/world_format.md @@ -183,7 +183,7 @@ For `load_mod_`, the possible values are: # Player File Format Should be pretty self-explanatory. -> **Note**: Position is in `nodes * 10` +> [!NOTE] Position is in `nodes * 10` Example content: @@ -410,7 +410,7 @@ Timestamp and node ID mappings were introduced in map format version 29. * Always 2 ## Node Data -> **Note**: Zlib-compressed before map format version 29 +> [!NOTE] Zlib-compressed before map format version 29 * If `content_width` is 1: * `u8[4096]`: `param0` fields @@ -425,7 +425,7 @@ Timestamp and node ID mappings were introduced in map format version 29. * The location of a node in each of those arrays is `(z*16*16 + y*16 + x)`. ### Node Metadata List -> **Note**: Zlib-compressed before map version format 29 +> [!NOTE] Zlib-compressed before map version format 29 * Before map format version 23: * `u16` version (=1) * `u16` count of metadata @@ -437,7 +437,7 @@ Timestamp and node ID mappings were introduced in map format version 29. * Since map format version 23: * `u8` version - > **Note**: Type was `u16` before map format version 23 + > [!NOTE] Type was `u16` before map format version 23 * = 1 before map format version 28 * = 2 since map format version 28 * `u16` count of metadata @@ -458,7 +458,7 @@ Timestamp and node ID mappings were introduced in map format version 29. * `u8` unused version (always 0) * Map format version 24: - > **Note**: Not released as stable + > [!NOTE] Not released as stable * `u8` `nodetimer_version` * if `nodetimer_version` == 1: * `u16` `num_of_timers`