Added documentation

metosin · May 10, 2016 · 90f0a74 · 90f0a74
1 parent 50b67c6
commit 90f0a74
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,8 +1,8 @@
 ## 0.3.0-SNAPSHOT
 
-* *BREAKING*: Removed type-level interceptors from ring-adapter.
+* **BREAKING**: Removed type-level interceptors from ring-adapter.
 * Support for Context-based urls, thanks to [Wout Neirynck](https://github.com/wneirynck).
-* *BREAKING*: top-level swagger options are now in align to the compojure-api:
+* **BREAKING**: top-level swagger options are now in align to the compojure-api:
   * Fixes [#22](https://github.com/metosin/kekkonen/issues/22)
   * By default, `api`s don't bind swagger-spec & swagger-ui, use `:spec` & `:ui` options
 

diff --git a/src/kekkonen/swagger.clj b/src/kekkonen/swagger.clj
@@ -65,7 +65,9 @@
     (assoc swagger :basePath context)
     swagger))
 
-(defn swagger-handler [swagger options]
+(defn swagger-handler
+  "Creates a handler, that serves the swagger-spec"
+  [swagger options]
   (if-let [spec (:spec options)]
     (k/handler
       {:type :kekkonen.ring/handler