docs(pdk) fix a mistake in the 'request.get_http_version()' documenta…

…tion From Kong#5072
veetow · Sep 26, 2019 · 2b952bd · 2b952bd
1 parent 6668c3b
commit 2b952bd
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/kong/pdk/request.lua b/kong/pdk/request.lua
@@ -237,14 +237,14 @@ local function new(self)
 
   ---
   -- Returns the HTTP version used by the client in the request as a Lua
-  -- number, returning values such as `"1.1"` and `"2.0."`, or `nil` for
+  -- number, returning values such as `1.1` and `2.0.`, or `nil` for
   -- unrecognized values.
   --
   -- @function kong.request.get_http_version
   -- @phases rewrite, access, header_filter, body_filter, log, admin_api
-  -- @treturn string|nil the http version
+  -- @treturn number|nil the HTTP version as a Lua number
   -- @usage
-  -- kong.request.get_http_version() -- "1.1"
+  -- kong.request.get_http_version() -- 1.1
   function _REQUEST.get_http_version()
     check_phase(PHASES.request)
 

diff --git a/t/01-pdk/04-request/07-get_http_version.t b/t/01-pdk/04-request/07-get_http_version.t
@@ -52,7 +52,7 @@ version: 1.1
 
 
 
-=== TEST 3: request.get_http_version() returns number
+=== TEST 3: request.get_http_version() returns a number
 --- http_config eval: $t::Util::HttpConfig
 --- config
     location = /t {