From bfe58d65f14dbdf3bcf57d069e7090637bcecc6e Mon Sep 17 00:00:00 2001 From: Nick Diego Yamane Date: Mon, 14 Aug 2017 10:06:44 -0400 Subject: [PATCH] docs: fix some typos/leftovers (#1989) Signed-off-by: Nick Yamane --- docs/90-FAQ.md | 4 ++-- docs/common/widget.ldoc | 6 +++--- lib/awful/rules.lua | 5 ++++- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/90-FAQ.md b/docs/90-FAQ.md index 1e86036f..b55c150b 100644 --- a/docs/90-FAQ.md +++ b/docs/90-FAQ.md @@ -92,9 +92,9 @@ Example key binding for your `globalkeys`: If you want to execute a shell command or need to execute a command that uses redirection, pipes and so on, do not use the `awful.spawn` function but -`awful.util.spawn_with_shell`. Here is an example: +`awful.spawn.with_shell`. Here is an example: - awful.key({ modkey }, "F10", function () awful.util.spawn_with_shell("cal -m | xmessage -timeout 10 -file -") end) + awful.key({ modkey }, "F10", function () awful.spawn.with_shell("cal -m | xmessage -timeout 10 -file -") end) On zsh, any changes to $PATH you do in `~/.zshrc` will not be picked up (because this is only run for interactive shells). Use `~/.zshenv` instead to make diff --git a/docs/common/widget.ldoc b/docs/common/widget.ldoc index cae2e47f..0c49c317 100644 --- a/docs/common/widget.ldoc +++ b/docs/common/widget.ldoc @@ -1,11 +1,11 @@ ---- Get a widex index. +--- Get a widget index. -- @param widget The widget to look for -- @param[opt] recursive Also check sub-widgets --- @param[opt] ... Aditional widgets to add at the end of the "path" +-- @param[opt] ... Aditional widgets to add at the end of the path -- @return The index -- @return The parent layout --- @return The path between "self" and "widget" +-- @return The path between self and widget -- @function index --- Get all direct and indirect children widgets. diff --git a/lib/awful/rules.lua b/lib/awful/rules.lua index 8d12aee5..d45a81e7 100644 --- a/lib/awful/rules.lua +++ b/lib/awful/rules.lua @@ -247,7 +247,7 @@ end -- By default, the table has the following functions: -- -- * geometry --- * switchtotag +-- * placement -- -- @tfield table awful.rules.extra_properties rules.extra_properties = {} @@ -275,6 +275,9 @@ rules.high_priority_properties = {} --- Delayed properties. -- Properties applied after all other categories. -- @tfield table awful.rules.delayed_properties +-- By default, the table has the following functions: +-- +-- * switchtotag rules.delayed_properties = {} local force_ignore = {