diff --git a/docs/references/api/bindings/json.md b/docs/references/api/bindings/json.md index 3020b1a1..fc43f201 100644 --- a/docs/references/api/bindings/json.md +++ b/docs/references/api/bindings/json.md @@ -22,7 +22,7 @@ All of the [lua-rapidjson](https://github.com/xpol/lua-rapidjson/blob/master/API Returns the embedded rapidjson library version as a Lua string. The lua-rapidjson (bindings) version can be queried via `_VERSION`. - + @@ -32,7 +32,7 @@ Returns the embedded rapidjson library version as a Lua string. The lua-rapidjso Parses the given input as a JSON string and returns a Lua table containing the equivalent data. Alias for `json.decode(...)`. - + @@ -45,7 +45,7 @@ Parses the given input as a JSON string and returns a Lua table containing the e Converts the given input table to a JSON string containing the equivalent data. Alias for `json.encode(...)`. - + @@ -58,7 +58,7 @@ Converts the given input table to a JSON string containing the equivalent data. Identical to `json.encode(...)`, but accepts both strings and tables. Returns a human-readable JSON string with indentation and key sorting enabled. Indentation uses four spaces (lua-rapidjson default). You probably don't want to use this for performance-critical code. - + @@ -71,7 +71,7 @@ Identical to `json.encode(...)`, but accepts both strings and tables. Returns a Identical to `json.pretty`, but uses tabs for indentation (instead of four spaces). This saves some space, but is still unsuitable for performance-critical code paths due to the overhead of sorting and possibly redundantly re-encoding the provided string value. - + diff --git a/docs/references/api/bindings/miniz.md b/docs/references/api/bindings/miniz.md index 11c19299..1e3a115a 100644 --- a/docs/references/api/bindings/miniz.md +++ b/docs/references/api/bindings/miniz.md @@ -54,7 +54,7 @@ Most of the time, you'll want to pass `"no"` or `"finish"` for asynchronous and ::: - + @@ -73,7 +73,7 @@ Created by [new_inflator](#new_inflator). You can use this to decompress large a Applies [INFLATE](https://en.wikipedia.org/wiki/Deflate#Decoder/decompressor) to the given (DEFLATE-compressed) `input` and returns the decompressed bytes as a Lua string. - + @@ -91,7 +91,7 @@ Created by [new_reader](#new_reader) or [new_reader_memory](#new_reader_memory). Extracts the file referenced by the given `fileTableIndex` and returns the file contents (or `""` on failure). The `flags` are passed to `miniz` directly. Since the extraction happens entirely in memory, this method may not be well-suited for extracting very large files. - + @@ -105,7 +105,7 @@ Extracts the file referenced by the given `fileTableIndex` and returns the file Returns the file name referenced by the given `fileTableIndex`, or `nil` and an error message if the given index was invalid. - + @@ -120,7 +120,7 @@ Returns the file name referenced by the given `fileTableIndex`, or `nil` and an Returns the total number of files within the ZIP archive. This is the maximum `fileTableIndex` that you can pass to other functions. - + @@ -139,7 +139,7 @@ This offset is likely zero for normal archives, but the file format allows stori ::: - + @@ -152,7 +152,7 @@ This offset is likely zero for normal archives, but the file format allows stori Returns `true` if the entry referenced by the given `fileTableIndex` is a directory entry, and `false` otherwise. - + @@ -166,7 +166,7 @@ Returns `true` if the entry referenced by the given `fileTableIndex` is a direct Searches the internal file system table of the given ZIP archive for an entry that matches `fileSystemPath` and returns the corresponding `fileTableIndex`, or `nil` and an error message if no match was found. It uses a simple linear search method that might have to iterate over the entire table, which is slow for very large files. The `flags` passed to `miniz` can control the way that the search is performed. - + @@ -180,7 +180,7 @@ Searches the internal file system table of the given ZIP archive for an entry th Returns a list of attributes for the entry referenced by the given `fileTableIndex`, or `nil` and an error message if the index was invalid. - + @@ -215,7 +215,7 @@ Created by [new_writer](#new_writer). You can use this to add files to a ZIP arc Adds (in-memory) a new file entry referenced by `fileSystemPath` with the given `fileContents` to the archive. The `flags` passed to `miniz` control the compression level and settings for this specific entry; it's a bitfield with the level being stored in the lowest byte. - + @@ -227,7 +227,7 @@ Adds (in-memory) a new file entry referenced by `fileSystemPath` with the given Adds (in-memory) the contents of the entry referenced by the given `fileTableIndex` from another ZIP archive to the archive. - + @@ -245,7 +245,7 @@ Once the archive has been finalized, you can no longer add new entries to it. Yo ::: - + @@ -260,7 +260,7 @@ Once the archive has been finalized, you can no longer add new entries to it. Yo Returns the [Adler-32](https://en.wikipedia.org/wiki/Adler-32) checksum for the given `input`. Supplying an `initialValue` allows processing multiple chunks as they arrive. - + @@ -274,7 +274,7 @@ Returns the [Adler-32](https://en.wikipedia.org/wiki/Adler-32) checksum for the Returns the [CRC-32](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) checksum for the given `input`. Supplying an `initialValue` allows processing multiple chunks as they arrive. - + @@ -300,7 +300,7 @@ While you don't need to worry about buffer allocation with either of these, the ::: - + @@ -316,7 +316,7 @@ Applies [DEFLATE](https://en.wikipedia.org/wiki/Deflate) to the given `input` an The `flags` passed to `miniz` control the behavior of the compressor. - + @@ -332,7 +332,7 @@ Applies [INFLATE](https://en.wikipedia.org/wiki/Deflate#Decoder/decompressor) to The `flags` passed to `miniz` control the behavior of the decompressor. - + @@ -346,7 +346,7 @@ The `flags` passed to `miniz` control the behavior of the decompressor. Returns the last compression or decompression error (as a human-readable string) if any was encountered, or `nil` otherwise. - + @@ -356,7 +356,7 @@ Returns the last compression or decompression error (as a human-readable string) Creates a new [Deflator](#deflator) object and returns a `userdata` reference to it. If you set `compressionLevel`, it must be a valid value (0 to 9). - + @@ -369,7 +369,7 @@ Creates a new [Deflator](#deflator) object and returns a `userdata` reference to Creates a new [Inflator](#inflator) object and returns a `userdata` reference to it. - + @@ -385,7 +385,7 @@ This function is suitable if loading the entire file into memory is acceptable. Returns `nil` and an error message in case of failure. Otherwise the ZIP [reader](#ZipFileReader) should be ready to use. - + @@ -406,7 +406,7 @@ This function is suitable if loading the entire file into memory is acceptable. Returns `nil` and an error message in case of failure. Otherwise the ZIP [reader](#ZipFileReader) should be ready to use. - + @@ -421,7 +421,7 @@ Returns `nil` and an error message in case of failure. Otherwise the ZIP [reader Creates a new ZIP file writer for the given `fileSystemPath`. The `flags` passed to `miniz` can control the way that the archive is written. - + @@ -449,7 +449,7 @@ While you don't need to worry about buffer allocation with either of these, the ::: - + @@ -463,7 +463,7 @@ While you don't need to worry about buffer allocation with either of these, the Returns the version number of the embedded `miniz` library as a Lua string. - + diff --git a/docs/references/api/bindings/stbi.md b/docs/references/api/bindings/stbi.md index 5d4fc867..2f53f3a2 100644 --- a/docs/references/api/bindings/stbi.md +++ b/docs/references/api/bindings/stbi.md @@ -38,7 +38,7 @@ Replaces all pixels using the RGBA values from `sourceColor` with those from `re The pixel format used by the given `image` is expected to be in RGBA format; use [stbi_load_rgba](#stbi_load_rgba) to ensure this is always the case. - + @@ -76,6 +76,8 @@ Converts the pixel format of an `image` from ABGR to RGBA (and vice versa), by s void stbi_abgr_to_rgba(stbi_image_t* image) ``` + + ### stbi_flip_vertically_on_write Globally toggles the vertical direction that is used when encoding images. A non-zero flag means that the pixel data is inverted. @@ -252,6 +254,7 @@ const char* stbi_version(void); | Version | What happened? | | :-----: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| v0.0.19 | Added `replace_pixel_color_rgba` | | v0.0.10 | Added `stbi_abgr_to_rgba` | | v0.0.9 | Removed `stbi_max_bitmap_size` in favor of `stbi_get_required_bmp_size`, `stbi_get_required_png_size`, `stbi_get_required_jpg_size`, and `stbi_get_required_tga_size` | | v0.0.7 | Added `stbi_flip_vertically_on_write` | diff --git a/docs/references/api/extensions.md b/docs/references/api/extensions.md index d4af37c6..2225e84e 100644 --- a/docs/references/api/extensions.md +++ b/docs/references/api/extensions.md @@ -24,7 +24,7 @@ debug.dump({ 1, 2, 3 }) Prints a human-readable string representation of the given object. Mostly useful for dumping tables, but unsuitable for serialization purposes. The output format cannot be considered stable. Currently uses [inspect](/docs/references/api/bindings/inspect) internally, though this may change in the future. - + @@ -39,7 +39,7 @@ Prints a human-readable string representation of the given object. Mostly useful Returns a string representing the difference between `firstValue` and `secondValue`. The exact format is subject to change. - + @@ -53,7 +53,7 @@ Returns a string representing the difference between `firstValue` and `secondVal Tokenizes the given `inputString` based on a configurable `delimiter` character, which is stripped from the output. - + @@ -67,7 +67,7 @@ Tokenizes the given `inputString` based on a configurable `delimiter` character, Returns a human-readable representation of the given `fileSizeInBytes` using standard units. The exact format is subject to change. - + @@ -82,7 +82,7 @@ Returns a human-readable representation of the given `fileSizeInBytes` using sta Returns `true` if the given `table` contains `value` in the array part of the table, and `false` otherwise. The dictionary part is ignored. - + diff --git a/docs/references/api/globals.md b/docs/references/api/globals.md index 8f198ff9..3b6e9e49 100644 --- a/docs/references/api/globals.md +++ b/docs/references/api/globals.md @@ -67,7 +67,7 @@ Alias for [debug.dump(...)](/docs/references/api/extensions#debugdump). Sets up the metatable of `child` so that it acts as an instance of `parent` (in terms of [object-oriented programming](https://en.wikipedia.org/wiki/Object-oriented_programming)). - + diff --git a/docs/references/api/libraries/assertions.md b/docs/references/api/libraries/assertions.md index 8d5bcc94..eeb6d255 100644 --- a/docs/references/api/libraries/assertions.md +++ b/docs/references/api/libraries/assertions.md @@ -20,7 +20,7 @@ local assertions = require("assertions") Raises an error if the function passed doesn't call the target function. The function has to be executed in order to determine this fact. - + @@ -31,7 +31,7 @@ Raises an error if the function passed doesn't call the target function. The fun Raises an error if the function passed throws (raises an error) itself. The purpose of this is to generate standardized error messages. - + @@ -41,7 +41,7 @@ Raises an error if the function passed throws (raises an error) itself. The purp Raises an error if the two passed values are not identical. This is a catch-all handler that uses the more specialized assertions internally. - + @@ -52,7 +52,7 @@ Raises an error if the two passed values are not identical. This is a catch-all Raises an error if the two passed values do not represent the same `boolean` value. - + @@ -63,7 +63,7 @@ Raises an error if the two passed values do not represent the same `boolean` val Raises an error if the two passed values do not represent the same `cdata` bytes. Use [assertEqualPointers](#assertequalpointers) to compare only the pointer. - + @@ -74,7 +74,7 @@ Raises an error if the two passed values do not represent the same `cdata` bytes Raises an error if the two passed values do not represent the same `function` value. - + @@ -85,7 +85,7 @@ Raises an error if the two passed values do not represent the same `function` va Raises an error if the two passed values do not represent the same `number` value. The optional `delta` allows for float comparisons. - + @@ -97,7 +97,7 @@ Raises an error if the two passed values do not represent the same `number` valu Raises an error if the two passed values do not represent the same `cdata` pointer. Use [assertEqualBytes](#assertequalbytes) to compare them by value. - + @@ -108,7 +108,7 @@ Raises an error if the two passed values do not represent the same `cdata` point Raises an error if the two passed values do not represent the same `string` value. Supports LuaJIT string buffers and `cdata` strings. - + @@ -119,7 +119,7 @@ Raises an error if the two passed values do not represent the same `string` valu Raises an error if the two passed values do not represent the same `table` value. Supports deep table comparisons. - + @@ -130,7 +130,7 @@ Raises an error if the two passed values do not represent the same `table` value Raises an error if the function passed does not return a "failure" type (`nil` and an error message). - + @@ -141,7 +141,7 @@ Raises an error if the function passed does not return a "failure" type (`nil` a Raises an error if the value passed is not exactly `false`. - + @@ -151,7 +151,7 @@ Raises an error if the value passed is not exactly `false`. Raises an error if the value passed is not exactly `nil`. - + @@ -161,7 +161,7 @@ Raises an error if the value passed is not exactly `nil`. Raises an error if the function passed does not itself raise an error (with the expected error message). - + @@ -172,7 +172,7 @@ Raises an error if the function passed does not itself raise an error (with the Raises an error if the value passed is not exactly `true`. - + diff --git a/docs/references/api/libraries/bdd.md b/docs/references/api/libraries/bdd.md index f1c046fc..0d4d2737 100644 --- a/docs/references/api/libraries/bdd.md +++ b/docs/references/api/libraries/bdd.md @@ -20,7 +20,7 @@ local bdd = require("bdd") Signals to the test runner that a new [section](/docs/how-to-guides/unit-testing#sections-and-subsections) should be started. You should only ever call this from within a test file. - + @@ -31,7 +31,7 @@ Signals to the test runner that a new [section](/docs/how-to-guides/unit-testing Returns a [human-readable string representation](#gethumanreadabletime) of the elapsed time for the current test run, which is the period between the last call to [startTestRunner](#starttestrunner) and now. If the tests have all been executed, the elapsed time is the total duration of the test run. - + @@ -41,7 +41,7 @@ Returns a [human-readable string representation](#gethumanreadabletime) of the e Returns a table containing error information about the last (or current) test run. Errors accumulate in-order; i.e., the table is an array. - + @@ -57,7 +57,7 @@ Returns a table containing error information about the last (or current) test ru This utility method formats a duration, assumed to be given in nanoseconds, for human consumption. You cannot rely on the format being stable, just that it's easy to read (for an arbitrary definition of "easy"). It's intended to format the time for completed test runs. - + @@ -70,7 +70,7 @@ This utility method formats a duration, assumed to be given in nanoseconds, for Returns the contents of the internal report buffer. You can use this after the test run has finished in order to print a summary. - + @@ -80,7 +80,7 @@ Returns the contents of the internal report buffer. You can use this after the t Returns whether the test runner is set to use the [basic reporting mode](/docs/how-to-guides/unit-testing#basic-reports). - + @@ -90,7 +90,7 @@ Returns whether the test runner is set to use the [basic reporting mode](/docs/h Returns whether the test runner is set to use the [detailed reporting mode](/docs/how-to-guides/unit-testing#detailed-reports). - + @@ -100,7 +100,7 @@ Returns whether the test runner is set to use the [detailed reporting mode](/doc Returns whether the test runner is set to use the [minimal reporting mode](/docs/how-to-guides/unit-testing#minimal-reports). - + @@ -110,7 +110,7 @@ Returns whether the test runner is set to use the [minimal reporting mode](/docs Signals to the test runner that a new [subsection](/docs/how-to-guides/unit-testing#sections-and-subsections) should be started. You should only ever call this from within a test file. - + @@ -121,7 +121,7 @@ Signals to the test runner that a new [subsection](/docs/how-to-guides/unit-test Adds a given message to the internal report buffer, so that it will be included in the final report after all tests have run. Inserts newlines (`\n`) after each message to simulate print-like semantics. Converts non-string values according to the usual LuaJIT conventions. - + @@ -155,7 +155,7 @@ Only one test runner can be started at a time. Manipulating its state from insid ::: - + diff --git a/docs/references/api/libraries/console.md b/docs/references/api/libraries/console.md index e6a09aec..ba699a13 100644 --- a/docs/references/api/libraries/console.md +++ b/docs/references/api/libraries/console.md @@ -26,7 +26,7 @@ Currently only captures [print](https://www.lua.org/manual/5.1/manual.html#pdf-p Stops capturing console output, allowing it to be displayed normally again. Returns the contents of the internal buffer and then resets it. - + @@ -38,7 +38,7 @@ Starts a console timer with the given `label`, saving the current (high-resoluti This is a lightweight helper that takes a snapshot in time when called; it doesn't actually start a "real" (libuv/OS) timer. - + @@ -50,7 +50,7 @@ Stops the console timer with the given `label` if it exists, marking the end of The computed time delta is returned, but also reported to the console in a human-readable (but otherwise unspecified) format. - + diff --git a/docs/references/api/libraries/path.md b/docs/references/api/libraries/path.md index 583dd5b7..db366aa5 100644 --- a/docs/references/api/libraries/path.md +++ b/docs/references/api/libraries/path.md @@ -24,7 +24,7 @@ Returns the filename and extension of the given `fileSystemPath` (ignoring trail If an extension is also given, the matched component (case-sensitive) will be stripped from the result before returning it. - + @@ -38,7 +38,7 @@ If an extension is also given, the matched component (case-sensitive) will be st Returns the directory path of the given `fileSystemPath` (ignoring trailing separators), similar to the Unix [dirname](https://en.wikipedia.org/wiki/Dirname) command. - + @@ -51,7 +51,7 @@ Returns the directory path of the given `fileSystemPath` (ignoring trailing sepa Returns the file extension of the given `fileSystemPath`. This is an empty string if the given file has no extension (or is a directory). - + @@ -64,7 +64,7 @@ Returns the file extension of the given `fileSystemPath`. This is an empty strin Returns `true` if the given `fileSystemPath` is an absolute (fully-qualified) path, and `false` otherwise. - + @@ -77,7 +77,7 @@ Returns `true` if the given `fileSystemPath` is an absolute (fully-qualified) pa Returns the normalized `fileSystemPath` constructed from the given path segments and the platform-specific path separator. - + @@ -90,7 +90,7 @@ Returns the normalized `fileSystemPath` constructed from the given path segments Returns the normalized `fileSystemPath` after resolving `.` and `..` segments. Preserves trailing separators, but removes duplicates. - + @@ -103,7 +103,7 @@ Returns the normalized `fileSystemPath` after resolving `.` and `..` segments. P Returns the relative path from `from` to `to` based on the current working directory. - + @@ -119,7 +119,7 @@ Returns the `fileSystemPath` constructed by resolving a sequence of paths (or pa This is conceptually similar to running a sequence of `cd` commands and writing down the end result (i.e., where you landed). - + diff --git a/docs/references/api/libraries/transform.md b/docs/references/api/libraries/transform.md index 3a121949..b228443a 100644 --- a/docs/references/api/libraries/transform.md +++ b/docs/references/api/libraries/transform.md @@ -20,7 +20,7 @@ local transform = require("transform") Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered black in supporting terminals. - + @@ -33,7 +33,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered on a black background in supporting terminals. - + @@ -46,7 +46,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered with bold font in supporting terminals. - + @@ -59,7 +59,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered bright red in supporting terminals. - + @@ -72,7 +72,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered on a bright red background in supporting terminals. - + @@ -85,7 +85,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered cyan in supporting terminals. - + @@ -106,7 +106,7 @@ Globally disables text transformations. This operation is not applied retroactiv Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered gray in supporting terminals. - + @@ -119,7 +119,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered green in supporting terminals. - + @@ -132,7 +132,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered on a green background in supporting terminals. - + @@ -145,7 +145,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered dark red in supporting terminals. - + @@ -158,7 +158,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered underlined in supporting terminals. - + @@ -171,7 +171,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered yellow in supporting terminals. - + @@ -184,7 +184,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered white in supporting terminals. - + @@ -197,7 +197,7 @@ Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia Returns the input string wrapped in [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code) so that it is rendered on a white background in supporting terminals. - + diff --git a/docs/references/api/libraries/uuid.md b/docs/references/api/libraries/uuid.md index fe17d9ff..c21cbb60 100644 --- a/docs/references/api/libraries/uuid.md +++ b/docs/references/api/libraries/uuid.md @@ -26,7 +26,7 @@ A Lua string pattern that can be used to [match](https://www.lua.org/manual/5.1/ Generates a UUID using the default (basic) random number generator. May produce inferior randomness ([see details here](https://github.com/mariusbancila/stduuid#random-uuids)). - + @@ -36,7 +36,7 @@ Generates a UUID using the default (basic) random number generator. May produce Generates a UUID using the [mt19937](https://cplusplus.com/reference/random/mt19937/) random number generator. Produces high-quality randomness via [Mersenne Twister Engine](https://cplusplus.com/reference/random/mersenne_twister_engine/). - + @@ -46,7 +46,7 @@ Generates a UUID using the [mt19937](https://cplusplus.com/reference/random/mt19 Generates a [name-based]() UUID using SHA-1 hashing to deterministically produce an identifier based on a given [namespace-name-pair](https://stackoverflow.com/questions/10867405/generating-v5-uuid-what-is-name-and-namespace). - + @@ -64,7 +64,7 @@ Generates a UUID using a nonstandard, platform-specific random number generator. - Linux: [uuid_generate](https://man7.org/linux/man-pages/man3/uuid_generate.3.html) - Mac OS: [CFUUIDCreate](https://developer.apple.com/documentation/corefoundation/1542906-cfuuidcreate?language=objc) - + @@ -74,7 +74,7 @@ Generates a UUID using a nonstandard, platform-specific random number generator. Returns whether or not the given value is a valid RFC UUID string, i.e., whether it matches the [RFC_STRING_PATTERN](#rfc_string_pattern). - + diff --git a/docs/references/api/libraries/validation.md b/docs/references/api/libraries/validation.md index c89d66c5..6955a8c4 100644 --- a/docs/references/api/libraries/validation.md +++ b/docs/references/api/libraries/validation.md @@ -20,7 +20,7 @@ local validation = require("validation") Raises an error if the given argument is not a `boolean` value. - + @@ -31,7 +31,7 @@ Raises an error if the given argument is not a `boolean` value. Raises an error if the given argument is not a `function` value. - + @@ -42,7 +42,7 @@ Raises an error if the given argument is not a `function` value. Raises an error if the given argument is not a `number` value. - + @@ -53,7 +53,7 @@ Raises an error if the given argument is not a `number` value. Raises an error if the given argument is not a `string` value. - + @@ -64,7 +64,7 @@ Raises an error if the given argument is not a `string` value. Raises an error if the given argument is not a `cdata` value. The exact `ctype` is not checked in any way. - + @@ -75,7 +75,7 @@ Raises an error if the given argument is not a `cdata` value. The exact `ctype` Raises an error if the given argument is not a `table` value. - + @@ -86,7 +86,7 @@ Raises an error if the given argument is not a `table` value. Raises an error if the given argument is not a `thread` value (coroutine). - + @@ -97,7 +97,7 @@ Raises an error if the given argument is not a `thread` value (coroutine). Raises an error if the given argument is not a `userdata` value. - + diff --git a/docs/references/api/namespaces/runtime.md b/docs/references/api/namespaces/runtime.md index e6890686..c52c8ce5 100644 --- a/docs/references/api/namespaces/runtime.md +++ b/docs/references/api/namespaces/runtime.md @@ -24,7 +24,7 @@ Displays a text containing versioning information and some basic usage instructi Evaluates the string value passed in as a [Lua chunk](https://www.lua.org/pil/1.1.html) and returns all results. Propagates any errors that may be encountered. - + @@ -47,7 +47,7 @@ The value displayed is also exported globally via [EVO_VERSION](/docs/references Starts a [bdd-style unit test runner](/docs/references/api/libraries/bdd) in [basic reporting mode](/docs/how-to-guides/unit-testing#basic-reports) with the given list of test files as input and returns the result. - + @@ -60,7 +60,7 @@ Starts a [bdd-style unit test runner](/docs/references/api/libraries/bdd) in [ba Starts a [bdd-style unit test runner](/docs/references/api/libraries/bdd) in [detailed reporting mode](/docs/how-to-guides/unit-testing#detailed-reports) with the given list of test files as input and returns the result. - + @@ -73,7 +73,7 @@ Starts a [bdd-style unit test runner](/docs/references/api/libraries/bdd) in [de Starts a [bdd-style unit test runner](/docs/references/api/libraries/bdd) in [minimal reporting mode](/docs/how-to-guides/unit-testing#minimal-reports) with the given list of test files as input and returns the result. - +