docs: fix example server docstring (#652)

sukovanej · web-flow · commit f20929b9c359 · 2024-08-09T23:38:01.000+02:00
diff --git a/.changeset/gorgeous-suns-grin.md b/.changeset/gorgeous-suns-grin.md
@@ -0,0 +1,5 @@
+---
+"effect-http": patch
+---
+
+Fix `ExampleServer.makeSchema` docstring.
diff --git a/packages/effect-http/src/ExampleServer.ts b/packages/effect-http/src/ExampleServer.ts
@@ -1,5 +1,5 @@
 /**
- * The `exampleServer` function generates a `Server` implementation based
+ * The `ExampleServer.make` function generates a `RouterBuilder` implementation based
  * on an instance of `Api`. The listening server will perform all the
  * request and response validations similarly to a real implementation.
  *
@@ -56,7 +56,7 @@ export const handleRemaining: <A extends ApiEndpoint.ApiEndpoint.Any, E, R>(
 ) => RouterBuilder.RouterBuilder<never, E, R | ApiEndpoint.ApiEndpoint.Context<A>> = internal.handleRemaining
 
 /**
- * Generate an example `RouterBuilder` implementation.
+ * Generate an example value for the given schema.
  *
  * @category utils
  * @since 1.0.0
diff --git a/packages/effect-http/src/index.ts b/packages/effect-http/src/index.ts
@@ -55,7 +55,7 @@ export * as Client from "./Client.js"
 export * as ClientError from "./ClientError.js"
 
 /**
- * The `exampleServer` function generates a `Server` implementation based
+ * The `ExampleServer.make` function generates a `RouterBuilder` implementation based
  * on an instance of `Api`. The listening server will perform all the
  * request and response validations similarly to a real implementation.
  *

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"effect-http": patch
 +---
++
 +Fix `ExampleServer.makeSchema` docstring.
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/**`
`2`		- * The `exampleServer` function generates a `Server` implementation based
	`2`	+ * The `ExampleServer.make` function generates a `RouterBuilder` implementation based
`3`	`3`	* on an instance of `Api`. The listening server will perform all the
`4`	`4`	`* request and response validations similarly to a real implementation.`
`5`	`5`	`*`
`@@ -56,7 +56,7 @@ export const handleRemaining: <A extends ApiEndpoint.ApiEndpoint.Any, E, R>(`
`56`	`56`	`) => RouterBuilder.RouterBuilder<never, E, R \| ApiEndpoint.ApiEndpoint.Context<A>> = internal.handleRemaining`
`57`	`57`
`58`	`58`	`/**`
`59`		- * Generate an example `RouterBuilder` implementation.
	`59`	`+ * Generate an example value for the given schema.`
`60`	`60`	`*`
`61`	`61`	`* @category utils`
`62`	`62`	`* @since 1.0.0`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ export * as Client from "./Client.js"`
`55`	`55`	`export * as ClientError from "./ClientError.js"`
`56`	`56`
`57`	`57`	`/**`
`58`		- * The `exampleServer` function generates a `Server` implementation based
	`58`	+ * The `ExampleServer.make` function generates a `RouterBuilder` implementation based
`59`	`59`	* on an instance of `Api`. The listening server will perform all the
`60`	`60`	`* request and response validations similarly to a real implementation.`
`61`	`61`	`*`