Skip to content

Commit 5dbdf15

Browse files
committed
Make minor adjustment to API-CONVENTIONS.md wording
Co-authored-by: Hanno Becker <beckphan@amazon.co.uk> Signed-off-by: Hanno Becker <beckphan@amazon.co.uk>
1 parent 3c76933 commit 5dbdf15

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

API-CONVENTIONS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Return values must always be checked; the public API is annotated with `warn_unu
1414

1515
## Pointer arguments
1616

17-
All pointer arguments are assumed to be valid and non-NULL, and every buffer is assumed to have the size implied by its parameter type. mldsa-native does not check pointers for NULL and does not validate buffer sizes; passing a NULL or otherwise invalid pointer, or an undersized buffer, is undefined behavior. Ensuring these preconditions is the caller's responsibility.
17+
All pointers to non-empty buffers are assumed to be valid and non-NULL, and every buffer is assumed to have the size implied by its parameter type or associated length parameter. mldsa-native does not conduct pointer validity checks such as NULL comparisons; passing a NULL or otherwise invalid pointer, or an undersized buffer, is undefined behavior. Ensuring these preconditions is the caller's responsibility.
1818

1919
The exception is a pointer paired with a length: it may be NULL when that length is `0` — for example, the message `m` when `mlen == 0`, or `ctx` when `ctxlen == 0`. Such cases are called out in the per-function documentation.
2020

0 commit comments

Comments
 (0)