Fix inconsistent parameter doc in blob.c (#514)

ethereum · Oct 8, 2024 · 4106b76 · 4106b76
1 parent 0ff9f37
commit 4106b76
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/eip4844/blob.c b/src/eip4844/blob.c
@@ -24,7 +24,9 @@
  *
  * @param[out]  p       The output polynomial (array of field elements)
  * @param[in]   blob    The blob (an array of bytes)
- * @param[in]   n       The number of field elements in the polynomial/blob
+ *
+ * @remark The polynomial is of degree (at most) FIELD_ELEMENTS_PER_BLOB - 1. That is,
+ * the function will set the first FIELD_ELEMENTS_PER_BLOB elements of p.
  */
 C_KZG_RET blob_to_polynomial(fr_t *p, const Blob *blob) {
     C_KZG_RET ret;