From f60a22e511dfe34fdc78c239ace4b07c1bdd22d4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20B=C3=A4r?=
Date: Wed, 2 Sep 2020 07:46:19 +0200
Subject: [PATCH] Apply suggestions from code review
Co-authored-by: Anastasiia Sergienko <46891819+AnastasiiaSergienko@users.noreply.github.com>
---
Findings.md | 2 +-
doc/developer_guide/developer_guide.md | 3 +--
src/main/lua/exasollog/log.lua | 4 ++--
3 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/Findings.md b/Findings.md
index 2007f9c..8825187 100644
--- a/Findings.md
+++ b/Findings.md
@@ -1,3 +1,3 @@
# Prototype findings
-* `CREATE OR REPLACE LUA ADAPTER SCRIPT` does not work. Code seems cached. Requires dropping the script an recreating it.
+* `CREATE OR REPLACE LUA ADAPTER SCRIPT` does not work. Code seems cached. Requires dropping the script and recreating it.
diff --git a/doc/developer_guide/developer_guide.md b/doc/developer_guide/developer_guide.md
index f453ab5..f9f1e88 100644
--- a/doc/developer_guide/developer_guide.md
+++ b/doc/developer_guide/developer_guide.md
@@ -40,9 +40,8 @@ Most of those packages are only required for testing. While `cjson` is needed at
### Bundling the Main Script and the Modules
-As most non-trivial pieces of software, `row-level-security-lua` is modularized. While it is possible to install individual modules as Lua scripts in Exasol, this is also a lot of work. And the more modules you install individually, the higher the chances you forget to update one of them. A safer and more convenient way is to bundly everything into one script before the installation using [lua-amalg](https://github.com/siffiejoe/lua-amalg/).
+As most non-trivial pieces of software, `row-level-security-lua` is modularized. While it is possible to install individual modules as Lua scripts in Exasol, this is also a lot of work. And the more modules you install individually, the higher the chances you forget to update one of them. A safer and more convenient way is to bundle everything into one script before the installation using [lua-amalg](https://github.com/siffiejoe/lua-amalg/).
To make this process easier, the [Maven POM file](../../pom.xml) contains an execution that automates this step. Still it is necessary to add new modules by hand in the list of modules to be bundled in the POM.
Note that the entry point `request_dispatcher.lua` is a regular Lua script that must be added to the bundle using the `-s` switch and its relative path. The remaining bundle elements are Lua modules and must be listed in dot-notation.
-
diff --git a/src/main/lua/exasollog/log.lua b/src/main/lua/exasollog/log.lua
index f0cd966..c604059 100644
--- a/src/main/lua/exasollog/log.lua
+++ b/src/main/lua/exasollog/log.lua
@@ -32,7 +32,7 @@ local socket = require("socket")
-- first time.
--
--
--- You can use a high resolution timer. Note that this are
not
the sub-second units of the timestamp! Lua
+-- You can use a high resolution timer. Note that these are not
the sub-second units of the timestamp! Lua
-- timestamps only offer second resolution. Rather you get a time difference in milliseconds counted from the first time
-- the log is opened.
--
@@ -129,7 +129,7 @@ function M.set_level(level_name)
end
---
--- Write to a socket, print or discard message.
+-- Write to a socket, print or discard the message.
--
-- If a socket connection is established, this method writes to that socket. Otherwise if the global print function
-- exists (e.g. in a unit test) falls back to logging via print()
.