docs: update docstrings

matthewkeil · Apr 30, 2024 · e5a67e1 · e5a67e1
1 parent 37e8dd6
commit e5a67e1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/bindings/node.js/README.md b/bindings/node.js/README.md
@@ -7,7 +7,7 @@ API. The core functionality was originally a stripped-down copy of
 since then. This package wraps that native `c-kzg` C code in C/C++ NAPI
 bindings for use in node.js applications.
 
-Spec: <https://github.com/ethereum/consensus-specs/blob/dev/specs/eip4844/polynomial-commitments.md>
+Spec: <https://github.com/ethereum/consensus-specs/blob/dev/specs/deneb/polynomial-commitments.md>
 
 ## Prerequisites
 
@@ -64,11 +64,11 @@ const isValid = verifyBlobKzgProofBatch(blobs, commitments, proofs);
  * ".txt" extension.
  *
  * Uses user provided location first. If one is not provided then defaults to
- * the official Ethereum mainnet setup from the kzg ceremony. Should only be
- * used for cases where the Ethereum official mainnet kzg setup is acceptable.
+ * the official Ethereum mainnet setup from the KZG ceremony. Should only be
+ * used for cases where the Ethereum official mainnet KZG setup is acceptable.
  *
  * @param {string | undefined} filePath - .txt/.json file with setup configuration
- * @default - If no string is passed the default trusted setup from the Ethereum kzg ceremony is used
+ * @default - If no string is passed the default trusted setup from the Ethereum KZG ceremony is used
  *
  * @throws {TypeError} - Non-String input
  * @throws {Error} - For all other errors. See error message for more info

diff --git a/bindings/node.js/lib/kzg.d.ts b/bindings/node.js/lib/kzg.d.ts
@@ -30,11 +30,11 @@ export const FIELD_ELEMENTS_PER_BLOB: number;
  * ".txt" extension.
  *
  * Uses user provided location first. If one is not provided then defaults to
- * the official Ethereum mainnet setup from the kzg ceremony. Should only be
- * used for cases where the Ethereum official mainnet kzg setup is acceptable.
+ * the official Ethereum mainnet setup from the KZG ceremony. Should only be
+ * used for cases where the Ethereum official mainnet KZG setup is acceptable.
  *
  * @param {string | undefined} filePath
- * @default - If no string is passed the default trusted setup from the Ethereum kzg ceremony is used
+ * @default - If no string is passed the default trusted setup from the Ethereum KZG ceremony is used
  *
  * @throws {TypeError} - Non-String input
  * @throws {Error} - For all other errors. See error message for more info

diff --git a/bindings/node.js/lib/kzg.js b/bindings/node.js/lib/kzg.js
@@ -66,7 +66,7 @@ function transformTrustedSetupJson(filePath) {
  * @throws {TypeError} - Invalid file type
  * @throws {Error} - Invalid location or no default trusted setup found
  *
- * @remarks - This function is only exported for testing purposes.  It should
+ * @remarks - This function is only exported for testing purposes. It should
  *            not be used directly. Not included in the kzg.d.ts types for that
  *            reason.
  */