From e0f811dd2b47aa37afdb8dbddebf4a26c503455c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Mon, 25 Dec 2017 11:40:33 +0100 Subject: [PATCH] Fix the use of the term "Lua" --- docs/en/modules/file.md | 2 +- docs/en/modules/i2c.md | 4 ++-- docs/en/modules/node.md | 2 +- docs/en/modules/rfswitch.md | 2 +- docs/en/modules/rtctime.md | 2 +- docs/en/modules/sjson.md | 14 +++++++------- docs/en/modules/websocket.md | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/en/modules/file.md b/docs/en/modules/file.md index 3d679c40..7f144b76 100644 --- a/docs/en/modules/file.md +++ b/docs/en/modules/file.md @@ -150,7 +150,7 @@ Lists all files in the file system. none #### Returns -a lua table which contains the {file name: file size} pairs +a Lua table which contains the {file name: file size} pairs #### Example ```lua diff --git a/docs/en/modules/i2c.md b/docs/en/modules/i2c.md index a81ce37d..469bf8e4 100644 --- a/docs/en/modules/i2c.md +++ b/docs/en/modules/i2c.md @@ -112,14 +112,14 @@ Send an I²C stop condition. [i2c.read()](#i2cread) ## i2c.write() -Write data to I²C bus. Data items can be multiple numbers, strings or lua tables. +Write data to I²C bus. Data items can be multiple numbers, strings or Lua tables. ####Syntax `i2c.write(id, data1[, data2[, ..., datan]])` ####Parameters - `id` always 0 -- `data` data can be numbers, string or lua table. +- `data` data can be numbers, string or Lua table. #### Returns `number` number of bytes written diff --git a/docs/en/modules/node.md b/docs/en/modules/node.md index 2a3c24d8..e34c31f3 100644 --- a/docs/en/modules/node.md +++ b/docs/en/modules/node.md @@ -245,7 +245,7 @@ Redirects the Lua interpreter output to a callback function. Optionally also pri function tonet(str) sk:send(str) end -node.output(tonet, 1) -- serial also get the lua output. +node.output(tonet, 1) -- serial also get the Lua output. ``` ```lua diff --git a/docs/en/modules/rfswitch.md b/docs/en/modules/rfswitch.md index ee916efe..0c8a82ef 100644 --- a/docs/en/modules/rfswitch.md +++ b/docs/en/modules/rfswitch.md @@ -62,7 +62,7 @@ then call it asynchronously a few more times (e.g. using [node.task.post](../mod #### Example ```lua --- lua transmit radio code using protocol #1 +-- Lua transmit radio code using protocol #1 -- pulse_length 300 microseconds -- repeat 5 times -- use pin #7 (GPIO13) diff --git a/docs/en/modules/rtctime.md b/docs/en/modules/rtctime.md index 97ec3885..f8f0831e 100644 --- a/docs/en/modules/rtctime.md +++ b/docs/en/modules/rtctime.md @@ -39,7 +39,7 @@ Puts the ESP8266 into deep sleep mode, like [`node.dsleep()`](node.md#nodedsleep - The time slept will generally be considerably more accurate than with [`node.dsleep()`](node.md#nodedsleep). - A sleep time of zero does not mean indefinite sleep, it is interpreted as a zero length sleep instead. -When the sleep timer expires, the platform is rebooted and the lua code is started with the `init.lua` file. The clock is set reasonably accurately. +When the sleep timer expires, the platform is rebooted and the Lua code is started with the `init.lua` file. The clock is set reasonably accurately. #### Syntax `rtctime.dsleep(microseconds [, option])` diff --git a/docs/en/modules/sjson.md b/docs/en/modules/sjson.md index ab67f773..1bf3ed7b 100644 --- a/docs/en/modules/sjson.md +++ b/docs/en/modules/sjson.md @@ -19,11 +19,11 @@ The handling of json null is as follows: - Optionally, a single string can be specified in both the encoder and decoder. This string will be used in encoding/decoding to represent json null values. This string should not be used anywhere else in your data structures. A suitable value might be `"\0"`. -When encoding a lua object, if a function is found, then it is invoked (with no arguments) and the (single) returned value is encoded in the place of the function. +When encoding a Lua object, if a function is found, then it is invoked (with no arguments) and the (single) returned value is encoded in the place of the function. ## sjson.encoder() -This creates an encoder object that can convert a LUA object into a JSON encoded string. +This creates an encoder object that can convert a Lua object into a JSON encoded string. ####Syntax `sjson.encoder(table [, opts])` @@ -101,7 +101,7 @@ end ## sjson.decoder() -This makes a decoder object that can parse a JSON encoded string into a lua object. A metatable can be specified for all the newly created lua tables. This allows +This makes a decoder object that can parse a JSON encoded string into a Lua object. A metatable can be specified for all the newly created Lua tables. This allows you to handle each value as it is inserted into each table (by implementing the `__newindex` method). ####Syntax @@ -149,7 +149,7 @@ you only need the `download_url` keys, then the total size is around 600B. This ## sjson.decoder:write -This provides more data to be parsed into the lua object. +This provides more data to be parsed into the Lua object. ####Syntax `decoder:write(string)` @@ -159,7 +159,7 @@ This provides more data to be parsed into the lua object. - `string` the next piece of JSON encoded data ####Returns -The constructed lua object or `nil` if the decode is not yet complete. +The constructed Lua object or `nil` if the decode is not yet complete. ####Errors If a parse error occurrs during this decode, then an error is thrown and the parse is aborted. The object cannot be used again. @@ -167,7 +167,7 @@ If a parse error occurrs during this decode, then an error is thrown and the par ## sjson.decoder:result -This gets the decoded lua object, or raises an error if the decode is not yet complete. This can be called multiple times and will return the +This gets the decoded Lua object, or raises an error if the decode is not yet complete. This can be called multiple times and will return the same object each time. ####Syntax @@ -230,5 +230,5 @@ for k,v in pairs(t) do print(k,v) end ##Constants -There is one constant -- `sjson.NULL` -- which is used in lua structures to represent the presence of a JSON null. +There is one constant -- `sjson.NULL` -- which is used in Lua structures to represent the presence of a JSON null. diff --git a/docs/en/modules/websocket.md b/docs/en/modules/websocket.md index 5f319c7c..ce2be7b0 100644 --- a/docs/en/modules/websocket.md +++ b/docs/en/modules/websocket.md @@ -62,7 +62,7 @@ ws = websocket.createClient() ws:close() ws:close() -- nothing will happen -ws = nil -- fully dispose the client as lua will now gc it +ws = nil -- fully dispose the client as Lua will now gc it ``` @@ -137,7 +137,7 @@ ws:on("receive", function(_, msg, opcode) end) ws:on("close", function(_, status) print('connection closed', status) - ws = nil -- required to lua gc the websocket client + ws = nil -- required to Lua gc the websocket client end) ws:connect('ws://echo.websocket.org')