Add better docu

fabianfett · fabianfett · commit f55105915a6a · 2021-07-07T12:39:31.000+02:00
diff --git a/Sources/AsyncHTTPClient/RequestBag+StateMachine.swift b/Sources/AsyncHTTPClient/RequestBag+StateMachine.swift
@@ -255,6 +255,10 @@ extension RequestBag.StateMachine {
         }
     }
 
+    /// The response head has been received.
+    ///
+    /// - Parameter head: The response' head
+    /// - Returns: Whether the response should be forwarded to the delegate. Will be `false` if the request follows a redirect.
     mutating func receiveResponseHead(_ head: HTTPResponseHead) -> Bool {
         switch self.state {
         case .initialized, .queued:

Original file line number	Diff line number	Diff line change
`@@ -255,6 +255,10 @@ extension RequestBag.StateMachine {`
`255`	`255`	`}`
`256`	`256`	`}`
`257`	`257`
	`258`	`+ /// The response head has been received.`
	`259`	`+ ///`
	`260`	`+ /// - Parameter head: The response' head`
	`261`	+ /// - Returns: Whether the response should be forwarded to the delegate. Will be `false` if the request follows a redirect.
`258`	`262`	`mutating func receiveResponseHead(_ head: HTTPResponseHead) -> Bool {`
`259`	`263`	`switch self.state {`
`260`	`264`	`case .initialized, .queued:`