summary refs log tree commit diff stats
path: root/lib/pure
diff options
context:
space:
mode:
authorMiran <narimiran@disroot.org>2019-03-08 13:55:27 +0100
committerAndreas Rumpf <rumpf_a@web.de>2019-03-08 13:55:26 +0100
commitbba3a20e7ca50456fa1fc96ec4fa7e917113a840 (patch)
tree112c145c858ee0baa3b3d513edd98a1bff7a6a1b /lib/pure
parent3294ce3831b2a30f074ccaec3ae350296a34c1f0 (diff)
downloadNim-bba3a20e7ca50456fa1fc96ec4fa7e917113a840.tar.gz
documentation style tweaks (#10790)
* exports are the least important field in the docs:
  they are put in the last place (at the bottom)
* indent text after proc/type declaration for an easier navigation
  (noticeable difference between declarations and examples)
* quickfix invalid style in `asynchttpserver`
Diffstat (limited to 'lib/pure')
-rw-r--r--lib/pure/asynchttpserver.nim8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/pure/asynchttpserver.nim b/lib/pure/asynchttpserver.nim
index edccd6628..4aed42683 100644
--- a/lib/pure/asynchttpserver.nim
+++ b/lib/pure/asynchttpserver.nim
@@ -15,8 +15,8 @@
 ## allowing users to connect directly to this server.
 ##
 ##
-## Examples
-## --------
+## Basic usage
+## -----------
 ##
 ## This example will create an HTTP server on port 8080. The server will
 ## respond to all requests with a ``200 OK`` response code and "Hello World"
@@ -85,8 +85,8 @@ proc respond*(req: Request, code: HttpCode, content: string,
   ##
   ## This procedure will **not** close the client socket.
   ##
-  ## Examples
-  ## --------
+  ## Example:
+  ##
   ## .. code-block::nim
   ##    import json
   ##    proc handler(req: Request) {.async.} =