doc: made the code examples more realistic (better for direct copy&paste use).

Author: rainingmaster

README.markdown

@@ -1512,13 +1512,17 @@ This hook is often used to create per-worker reoccurring timers (via the [ngx.ti
                  return
              end
          end
+
+         -- do something in timer
      end
 
      local hdl, err = new_timer(delay, check)
      if not hdl then
          log(ERR, "failed to create timer: ", err)
          return
      end
+
+     -- other job in init_worker_by_lua
  ';
 ```
 
@@ -6292,13 +6296,13 @@ When the `replace` is a string, then it is treated as a special template for str
 ```lua
 
  local newstr, n, err = ngx.re.sub("hello, 1234", "([0-9])[0-9]", "[$0][$1]")
- if newstr then
-     -- newstr == "hello, [12][1]34"
-     -- n == 1
- else
+ if not newstr then
      ngx.log(ngx.ERR, "error: ", err)
      return
  end
+
+ -- newstr == "hello, [12][1]34"
+ -- n == 1
 ```
 
 where `$0` referring to the whole substring matched by the pattern and `$1` referring to the first parenthesized capturing substring.
@@ -6308,17 +6312,17 @@ Curly braces can also be used to disambiguate variable names from the background
 ```lua
 
  local newstr, n, err = ngx.re.sub("hello, 1234", "[0-9]", "${0}00")
-     -- newstr == "hello, 100234"
-     -- n == 1
+ -- newstr == "hello, 100234"
+ -- n == 1
 ```
 
 Literal dollar sign characters (`$`) in the `replace` string argument can be escaped by another dollar sign, for instance,
 
 ```lua
 
  local newstr, n, err = ngx.re.sub("hello, 1234", "[0-9]", "$$")
-     -- newstr == "hello, $234"
-     -- n == 1
+ -- newstr == "hello, $234"
+ -- n == 1
 ```
 
 Do not use backlashes to escape dollar signs; it will not work as expected.
@@ -6330,9 +6334,10 @@ When the `replace` argument is of type "function", then it will be invoked with
  local func = function (m)
      return "[" .. m[0] .. "][" .. m[1] .. "]"
  end
+
  local newstr, n, err = ngx.re.sub("hello, 1234", "( [0-9] ) [0-9]", func, "x")
-     -- newstr == "hello, [12][1]34"
-     -- n == 1
+ -- newstr == "hello, [12][1]34"
+ -- n == 1
 ```
 
 The dollar sign characters in the return value of the `replace` function argument are not special at all.
@@ -6357,13 +6362,13 @@ Here is some examples:
 ```lua
 
  local newstr, n, err = ngx.re.gsub("hello, world", "([a-z])[a-z]+", "[$0,$1]", "i")
- if newstr then
-     -- newstr == "[hello,h], [world,w]"
-     -- n == 2
- else
+ if not newstr then
      ngx.log(ngx.ERR, "error: ", err)
      return
  end
+
+ -- newstr == "[hello,h], [world,w]"
+ -- n == 2
 ```
 
 ```lua
@@ -6372,8 +6377,8 @@ Here is some examples:
      return "[" .. m[0] .. "," .. m[1] .. "]"
  end
  local newstr, n, err = ngx.re.gsub("hello, world", "([a-z])[a-z]+", func, "i")
-     -- newstr == "[hello,h], [world,w]"
-     -- n == 2
+ -- newstr == "[hello,h], [world,w]"
+ -- n == 2
 ```
 
 This method requires the PCRE library enabled in Nginx ([Known Issue With Special Escaping Sequences](#special-escaping-sequences)).
@@ -7078,6 +7083,9 @@ Since the `v0.7.18` release, connecting to a datagram unix domain socket file is
      ngx.say("failed to connect to the datagram unix domain socket: ", err)
      return
  end
+
+ -- do something after connect
+ -- such as sock:send or sock:receive
 ```
 
 assuming the datagram service is listening on the unix domain socket file `/tmp/some-datagram-service.sock` and the client socket will use the "autobind" feature on Linux.
@@ -7282,6 +7290,9 @@ Connecting to a Unix Domain Socket file is also possible:
      ngx.say("failed to connect to the memcached unix domain socket: ", err)
      return
  end
+
+ -- do something after connect
+ -- such as sock:send or sock:receive
 ```
 
 assuming memcached (or something else) is listening on the unix domain socket file `/tmp/memcached.sock`.
@@ -8160,6 +8171,8 @@ Here is a simple example:
              ngx.log(ngx.ERR, "failed to create timer: ", err)
              return
          end
+
+         -- other job in log_by_lua_block
      }
  }
 ```
@@ -8180,13 +8193,17 @@ One can also create infinite re-occurring timers, for instance, a timer getting
          ngx.log(ngx.ERR, "failed to create the timer: ", err)
          return
      end
+
+     -- do something in timer
  end
 
  local ok, err = ngx.timer.at(delay, handler)
  if not ok then
      ngx.log(ngx.ERR, "failed to create the timer: ", err)
      return
  end
+
+ -- do other jobs
 ```
 
 It is recommended, however, to use the [ngx.timer.every](#ngxtimerevery) API function

doc/HttpLuaModule.wiki

@@ -1224,13 +1224,17 @@ This hook is often used to create per-worker reoccurring timers (via the [[#ngx.
                     return
                 end
             end
+
+            -- do something in timer
         end
 
         local hdl, err = new_timer(delay, check)
         if not hdl then
             log(ERR, "failed to create timer: ", err)
             return
         end
+
+        -- other job in init_worker_by_lua
     ';
 </geshi>
 
@@ -5296,13 +5300,13 @@ When the <code>replace</code> is a string, then it is treated as a special templ
 
 <geshi lang="lua">
     local newstr, n, err = ngx.re.sub("hello, 1234", "([0-9])[0-9]", "[$0][$1]")
-    if newstr then
-        -- newstr == "hello, [12][1]34"
-        -- n == 1
-    else
+    if not newstr then
         ngx.log(ngx.ERR, "error: ", err)
         return
     end
+
+    -- newstr == "hello, [12][1]34"
+    -- n == 1
 </geshi>
 
 where <code>$0</code> referring to the whole substring matched by the pattern and <code>$1</code> referring to the first parenthesized capturing substring.
@@ -5311,16 +5315,16 @@ Curly braces can also be used to disambiguate variable names from the background
 
 <geshi lang="lua">
     local newstr, n, err = ngx.re.sub("hello, 1234", "[0-9]", "${0}00")
-        -- newstr == "hello, 100234"
-        -- n == 1
+    -- newstr == "hello, 100234"
+    -- n == 1
 </geshi>
 
 Literal dollar sign characters (<code>$</code>) in the <code>replace</code> string argument can be escaped by another dollar sign, for instance,
 
 <geshi lang="lua">
     local newstr, n, err = ngx.re.sub("hello, 1234", "[0-9]", "$$")
-        -- newstr == "hello, $234"
-        -- n == 1
+    -- newstr == "hello, $234"
+    -- n == 1
 </geshi>
 
 Do not use backlashes to escape dollar signs; it will not work as expected.
@@ -5331,9 +5335,10 @@ When the <code>replace</code> argument is of type "function", then it will be in
     local func = function (m)
         return "[" .. m[0] .. "][" .. m[1] .. "]"
     end
+
     local newstr, n, err = ngx.re.sub("hello, 1234", "( [0-9] ) [0-9]", func, "x")
-        -- newstr == "hello, [12][1]34"
-        -- n == 1
+    -- newstr == "hello, [12][1]34"
+    -- n == 1
 </geshi>
 
 The dollar sign characters in the return value of the <code>replace</code> function argument are not special at all.
@@ -5354,22 +5359,22 @@ Here is some examples:
 
 <geshi lang="lua">
     local newstr, n, err = ngx.re.gsub("hello, world", "([a-z])[a-z]+", "[$0,$1]", "i")
-    if newstr then
-        -- newstr == "[hello,h], [world,w]"
-        -- n == 2
-    else
+    if not newstr then
         ngx.log(ngx.ERR, "error: ", err)
         return
     end
+
+    -- newstr == "[hello,h], [world,w]"
+    -- n == 2
 </geshi>
 
 <geshi lang="lua">
     local func = function (m)
         return "[" .. m[0] .. "," .. m[1] .. "]"
     end
     local newstr, n, err = ngx.re.gsub("hello, world", "([a-z])[a-z]+", func, "i")
-        -- newstr == "[hello,h], [world,w]"
-        -- n == 2
+    -- newstr == "[hello,h], [world,w]"
+    -- n == 2
 </geshi>
 
 This method requires the PCRE library enabled in Nginx ([[#Special Escaping Sequences|Known Issue With Special Escaping Sequences]]).
@@ -5988,6 +5993,9 @@ Since the <code>v0.7.18</code> release, connecting to a datagram unix domain soc
         ngx.say("failed to connect to the datagram unix domain socket: ", err)
         return
     end
+
+    -- do something after connect
+    -- such as sock:send or sock:receive
 </geshi>
 
 assuming the datagram service is listening on the unix domain socket file <code>/tmp/some-datagram-service.sock</code> and the client socket will use the "autobind" feature on Linux.
@@ -6167,6 +6175,9 @@ Connecting to a Unix Domain Socket file is also possible:
         ngx.say("failed to connect to the memcached unix domain socket: ", err)
         return
     end
+
+    -- do something after connect
+    -- such as sock:send or sock:receive
 </geshi>
 
 assuming memcached (or something else) is listening on the unix domain socket file <code>/tmp/memcached.sock</code>.
@@ -6976,6 +6987,8 @@ Here is a simple example:
                 ngx.log(ngx.ERR, "failed to create timer: ", err)
                 return
             end
+
+            -- other job in log_by_lua_block
         }
     }
 </geshi>
@@ -6995,13 +7008,17 @@ One can also create infinite re-occurring timers, for instance, a timer getting
             ngx.log(ngx.ERR, "failed to create the timer: ", err)
             return
         end
+
+        -- do something in timer
     end
 
     local ok, err = ngx.timer.at(delay, handler)
     if not ok then
         ngx.log(ngx.ERR, "failed to create the timer: ", err)
         return
     end
+
+    -- do other jobs
 </geshi>
 
 It is recommended, however, to use the [[#ngx.timer.every|ngx.timer.every]] API function