From dba17fdddb2d0a7a832afb9480ec6515a38a15d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 14 Nov 2018 17:28:22 +0100
Subject: Document using undefined as content_types_provided callback

This is a convention that indicates the callback will never
be called, for example because the methods HEAD or GET are
not accepted.
---
 doc/src/guide/resource_design.asciidoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'doc/src/guide/resource_design.asciidoc')

diff --git a/doc/src/guide/resource_design.asciidoc b/doc/src/guide/resource_design.asciidoc
index 4ea0390..954d87d 100644
--- a/doc/src/guide/resource_design.asciidoc
+++ b/doc/src/guide/resource_design.asciidoc
@@ -136,7 +136,10 @@ are provided? What languages do I provide?
 
 Implement the mandatory `content_types_provided`. Prefix
 the callbacks with `to_` for clarity. For example, `to_html`
-or `to_text`.
+or `to_text`. For resources that don't implement methods
+GET or HEAD, you must still accept at least one media type,
+but you can leave the callback as `undefined` since it will
+never be called.
 
 Implement the `languages_provided` or `charsets_provided`
 callbacks if applicable.
-- 
cgit v1.2.3

