diff --git a/src/README.md b/src/README.md index 8ef939b7..e6c4fe2a 100644 --- a/src/README.md +++ b/src/README.md @@ -12,7 +12,7 @@ Functions starting with `q_` are queries/predicates, and return a boolean. Functions ending with `R` are either supposed to be called rarely, or the caller expects that a part of it happens rarely. Functions ending with `N` are non-inlined versions of another function. Functions ending with `F` are infrequently needed fallback parts of a function. -Functions ending with `P` (or sometimes containing `p` or `P`) take a pointer argument (as opposed to a (NaN-boxed) `B`). +Functions ending with `P` (or sometimes containing `p` or `P` or `v` or `V`) take a pointer argument (as opposed to a (NaN-boxed) `B`). Functions ending with `U` return (or take) a non-owned object (`U` = "unincremented"). Functions ending with `_c1` are monadic implementations, `_c2` are dyadic (see [builtin implementations](#builtin-implementations)) Functions ending with `G` can only be called with some guarantee (e.g. argument is heap-allocated, or fits in some type, etc).