Merge branch 'main' into ci-html-link-check

This commit is contained in:
Thomas Silkjær
2025-11-22 19:39:24 +01:00
committed by GitHub

View File

@@ -86,7 +86,7 @@ if (float_compare(pusd_to_send, 0n, COMPARE_LESS) == 1)
| ------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| float1 | int64_t | An XFL floating point enclosing number representing the first operand to the comparison |
| float2 | int64_t | An XFL floating point enclosing number representing the second operand to the comparison |
| mode | uint32_t | A bit-flag field consisting of any of (or any logically valid combination of) the following flags:<br /><code>COMPARE_LESS</code><br /><code>COMPARE_EQUAL</code><br /><code>COMPARE_GREATER</code><br /><br />Valid combinations are:<br /><code>COMPARE_LESS</code> | <code>COMPARE_GREATER</code><br />- Not equal<br /><br /><code>COMPARE_LESS</code> | <code>COMPARE_EQUAL</code><br />- Less than or equal to<br /><br /><code>COMPARE_GREATER</code> | <code>COMPARE_EQUAL</code><br />- Greater than or equal to |
| mode | uint32_t | A bit-flag field consisting of any of (or any logically valid combination of) the following flags:<br /><code>COMPARE_EQUAL</code> `1`<br /><code>COMPARE_LESS</code> `2`<br /><code>COMPARE_GREATER</code> `4`<br /><br />Valid combinations are:<br /><code>COMPARE_LESS</code> \| <code>COMPARE_GREATER</code><br />- Not equal<br /><br /><code>COMPARE_LESS</code> \| <code>COMPARE_EQUAL</code><br />- Less than or equal to<br /><br /><code>COMPARE_GREATER</code> \| <code>COMPARE_EQUAL</code><br />- Greater than or equal to |
<Aside type="caution">
Always verify the function returned `1` rather than `non-zero`, as negative error codes will be classed as `non-zero`.