Просмотр исходного кода

Add a few directions in the REST chapter in the guide

This is obviously not proper documentation. We will properly document
it when the API stabilizes.
Loïc Hoguin 12 лет назад
Родитель
Сommit
c1bf0a2792
1 измененных файлов с 8 добавлено и 3 удалено
  1. 8 3
      guide/rest_handlers.md

+ 8 - 3
guide/rest_handlers.md

@@ -12,17 +12,22 @@ REST is implemented in Cowboy as a protocol upgrade. Once upgraded,
 the request is handled as a state machine with many optional callbacks
 describing the resource and modifying the machine's behavior.
 
+As the REST handler is still subject to change, the documentation is
+still thin. This state of affair will be improved in the coming weeks.
+
 Flow diagram
 ------------
 
-@todo Add the beautiful flow diagram here.
+Not done yet. Feel free to use the one that is currently being worked on.
+
+ *  https://github.com/extend/cowboy/pull/364
 
 Callbacks
 ---------
 
-@todo Describe the callbacks.
+Please see the Webmachine documentation at this time.
 
 Usage
 -----
 
-@todo Explain how to use them.
+Please see the examples at this time.