From 1050237d04d5daab53a6bb7089f00fff60aac359 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Sat, 11 Jul 2015 22:53:57 +0200 Subject: [PATCH] minor: fix/improve doc comments --- awesomerc.lua | 4 ++-- common/lualib.h | 2 +- keygrabber.c | 2 +- lib/awful/keygrabber.lua | 6 +++--- lib/awful/rules.lua | 3 +-- xrdb.c | 2 +- 6 files changed, 9 insertions(+), 10 deletions(-) diff --git a/awesomerc.lua b/awesomerc.lua index 9b8ee01c..e1f1831d 100755 --- a/awesomerc.lua +++ b/awesomerc.lua @@ -395,13 +395,13 @@ client.connect_signal("manage", function (c) -- i.e. put it at the end of others instead of setting it master. -- awful.client.setslave(c) - -- Put windows in a smart way, only if they does not set an initial position. + -- Put windows in a smart way, only if they do not set an initial position. if not c.size_hints.user_position and not c.size_hints.program_position then awful.placement.no_overlap(c) awful.placement.no_offscreen(c) end elseif not c.size_hints.user_position and not c.size_hints.program_position then - -- Prevent clients from being unreachable after screen count change + -- Prevent clients from being unreachable after screen count changes. awful.placement.no_offscreen(c) end diff --git a/common/lualib.h b/common/lualib.h index af439601..513eef88 100644 --- a/common/lualib.h +++ b/common/lualib.h @@ -26,7 +26,7 @@ #include "common/util.h" -/** Lua function to call on dofuction() error */ +/** Lua function to call on dofunction() error */ lua_CFunction lualib_dofunction_on_error; void luaA_checkfunction(lua_State *, int); diff --git a/keygrabber.c b/keygrabber.c index 3cb361d1..b57972ba 100644 --- a/keygrabber.c +++ b/keygrabber.c @@ -75,7 +75,7 @@ is_control(char *buf) /** Handle keypress event. * \param L Lua stack to push the key pressed. * \param e Received XKeyEvent. - * \return True if a key was successfully get, false otherwise. + * \return True if a key was successfully retrieved, false otherwise. */ bool keygrabber_handlekpress(lua_State *L, xcb_key_press_event_t *e) diff --git a/lib/awful/keygrabber.lua b/lib/awful/keygrabber.lua index aac8ab1e..02b63d5b 100644 --- a/lib/awful/keygrabber.lua +++ b/lib/awful/keygrabber.lua @@ -80,11 +80,11 @@ end -- end) -- end function keygrabber.run(g) - -- Remove the grabber if its in stack + -- Remove the grabber if it is in the stack. keygrabber.stop(g) - -- Record the grabber has latest added + -- Record the grabber that has been added most recently. table.insert(grabbers, 1, g) - -- start the keygrabber if its not running already + -- Start the keygrabber if it is not running already. if not keygrabbing then keygrabbing = true capi.keygrabber.run(grabber) diff --git a/lib/awful/rules.lua b/lib/awful/rules.lua index 6e57d793..7a1eb11f 100644 --- a/lib/awful/rules.lua +++ b/lib/awful/rules.lua @@ -214,8 +214,7 @@ function rules.execute(c, props, callbacks) end end - -- Do this at last so we do not erase things done by the focus - -- signal. + -- Do this at last so we do not erase things done by the focus signal. if props.focus and (type(props.focus) ~= "function" or props.focus(c)) then c:emit_signal('request::activate', "rules", {raise=true}) end diff --git a/xrdb.c b/xrdb.c index a349b450..974dee75 100644 --- a/xrdb.c +++ b/xrdb.c @@ -39,7 +39,7 @@ static void xrdb_init(void) { /**/ if (!(globalconf.xrmdb = XrmGetDatabase(globalconf.display))) - warn("Can't open xrdb\n"); + warn("Cannot open xrdb."); } }