From 58e9e76814a8291894ba01ac8a4551e4f8d480b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 4 Sep 2017 14:33:44 +0200 Subject: Fix more documentation todos I have decided not to include a manual page for cowboy_stream_h at this point because it clashes with the cowboy_stream manual page. This decision will be revisited in the future. --- doc/src/manual/cowboy_handler.terminate.asciidoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'doc/src/manual/cowboy_handler.terminate.asciidoc') diff --git a/doc/src/manual/cowboy_handler.terminate.asciidoc b/doc/src/manual/cowboy_handler.terminate.asciidoc index f10d945..c995ba3 100644 --- a/doc/src/manual/cowboy_handler.terminate.asciidoc +++ b/doc/src/manual/cowboy_handler.terminate.asciidoc @@ -8,12 +8,12 @@ cowboy_handler:terminate - Terminate the handler [source,erlang] ---- -terminate(Reason, Req | undefined, State, Handler) -> ok +terminate(Reason, PartialReq, State, Handler) -> ok -Reason :: any() -Req :: cowboy_req:req() -State :: any() -Handler :: module() +Reason :: any() +PartialReq :: map() +State :: any() +Handler :: module() ---- Call the optional terminate callback if it is defined. @@ -27,13 +27,13 @@ Reason:: Reason for termination. -Req:: +PartialReq:: The Req object. + -It is possible to pass `undefined` if the handler has no concept -of requests/responses and discarded the Req object before calling -this function. +It is possible to remove fields from the Req object to save memory +when the handler has no concept of requests/responses. The only +requirement is that a map is provided. State:: -- cgit v1.2.3