Docs

adamw · adamw · commit abbe8f325e54 · 2024-05-27T19:04:36.000+02:00
diff --git a/core/src/main/scala/sttp/shared/package.scala b/core/src/main/scala/sttp/shared/package.scala
@@ -1,5 +1,9 @@
 package sttp
 
 package object shared {
+
+  /** The `Identity` type constructor can be used where an "effect" or wrapper (usually called `F[_]`) is expected. It
+    * represents direct-style / synchronous programming, and allows passing in code written in this style.
+    */
   type Identity[X] = X
 }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`package sttp`
`2`	`2`
`3`	`3`	`package object shared {`
	`4`	`+`
	`5`	+ /** The `Identity` type constructor can be used where an "effect" or wrapper (usually called `F[_]`) is expected. It
	`6`	`+ * represents direct-style / synchronous programming, and allows passing in code written in this style.`
	`7`	`+ */`
`4`	`8`	`type Identity[X] = X`
`5`	`9`	`}`