Doc edits

Convex-Dev · Jul 19, 2023 · a10254b · a10254b
1 parent f7695f8
commit a10254b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/convex-core/src/main/java/convex/core/data/Format.java b/convex-core/src/main/java/convex/core/data/Format.java
@@ -710,6 +710,11 @@ public static String encodedString(Object o) {
 		return encodedString(RT.cvm(o));
 	}
 
+	/**
+	 * Estimate the encoding size of a Cell value. Useful for pre-sizing buffers.
+	 * @param cell Cell to estimate encoding size for
+	 * @return Estimated encoding size. May not be precise.
+	 */
 	public static int estimateEncodingSize(ACell cell) {
 		if (cell==null) return 1;
 		return cell.estimatedEncodingSize();