fix jsdoc for Inspectable.format (#1720)

Effect-TS · Nov 30, 2023 · 56a0334 · 56a0334
1 parent af31997
commit 56a0334
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/.changeset/unlucky-rocks-perform.md b/.changeset/unlucky-rocks-perform.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+fix jsdoc for Inspectable.format
diff --git a/docs/modules/Inspectable.ts.md b/docs/modules/Inspectable.ts.md
@@ -18,6 +18,7 @@ Added in v2.0.0
  - [NodeInspectSymbol](#nodeinspectsymbol)
  - [NodeInspectSymbol (type alias)](#nodeinspectsymbol-type-alias)
 - [utils](#utils)
+ - [format](#format)
  - [toJSON](#tojson)
 
 ---
@@ -62,6 +63,16 @@ Added in v2.0.0
 
 # utils
 
+## format
+
+**Signature**
+
+```ts
+export declare const format: (x: unknown) => string
+```
+
+Added in v2.0.0
+
 ## toJSON
 
 **Signature**

diff --git a/src/Inspectable.ts b/src/Inspectable.ts
@@ -41,5 +41,7 @@ export const toJSON = (x: unknown): unknown => {
  return x
 }
 
-/** @internal */
+/**
+ * @since 2.0.0
+ */
 export const format = (x: unknown): string => JSON.stringify(x, null, 2)