API note

mwlon · Oct 30, 2023 · b95819e · b95819e
1 parent 8ecd212
commit b95819e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/pco/README.md b/pco/README.md
@@ -43,6 +43,12 @@ This allows
 (as long as the overall chunk has >2k or so)
 * less bloat by omitting metadata that the wrapping format must retain
 
+## Important API Note
+
+In some places, pco methods accept a destination (either W: Write or &mut [T: NumberLike]).
+If pco returns an error, the pco struct's state should be unaffected, but the destination
+may have been modified.
+
 ## Advanced
 
 ### Custom Data Types