Browse Source

Cosmetic changes to various documentation files

Loïc Hoguin 12 years ago
parent
commit
f63d3f08cf
3 changed files with 8 additions and 6 deletions
  1. 3 3
      README.md
  2. 2 1
      guide/toc.md
  3. 3 2
      src/cowboy_rest.erl

+ 3 - 3
README.md

@@ -21,9 +21,9 @@ No parameterized module. No process dictionary. **Clean** Erlang code.
 Quick start
 Quick start
 -----------
 -----------
 
 
- *  Add Cowboy as a rebar dependency to your application.
- *  Start Cowboy and add one or more listeners.
- *  Write handlers for your application.
+ *  Add Cowboy as a rebar dependency to your application
+ *  Start Cowboy and add one or more listeners
+ *  Write handlers for your application
 
 
 Getting Started
 Getting Started
 ---------------
 ---------------

+ 2 - 1
guide/toc.md

@@ -8,9 +8,10 @@ Cowboy User Guide
    *  Getting started
    *  Getting started
  *  Routing
  *  Routing
    *  Purpose
    *  Purpose
-   *  Dispatch rule
+   *  Dispatch list
    *  Match rules
    *  Match rules
    *  Bindings
    *  Bindings
+   *  Constraints
  *  Handlers
  *  Handlers
    *  Purpose
    *  Purpose
    *  Protocol upgrades
    *  Protocol upgrades

+ 3 - 2
src/cowboy_rest.erl

@@ -195,8 +195,9 @@ options(Req, State) ->
 %%
 %%
 %% Note that it is also possible to return a binary content type that will
 %% Note that it is also possible to return a binary content type that will
 %% then be parsed by Cowboy. However note that while this may make your
 %% then be parsed by Cowboy. However note that while this may make your
-%% resources a little more readable, this is a lot less efficient. An example
-%% of such a return value would be:
+%% resources a little more readable, this is a lot less efficient.
+%%
+%% An example of such return value would be:
 %%    {<<"text/html">>, to_html}
 %%    {<<"text/html">>, to_html}
 content_types_provided(Req, State) ->
 content_types_provided(Req, State) ->
 	case call(Req, State, content_types_provided) of
 	case call(Req, State, content_types_provided) of