From 742717ec22dd4632840734b562f2c3dfdcf32ace Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Mon, 4 Apr 2016 23:49:43 +0200 Subject: [PATCH] doc: improve doc for awful.screen.focused --- lib/awful/screen.lua | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/lib/awful/screen.lua b/lib/awful/screen.lua index 220185f88..4d9c81fcb 100644 --- a/lib/awful/screen.lua +++ b/lib/awful/screen.lua @@ -182,16 +182,14 @@ end --- Get the focused screen. -- --- Valid arguments are: --- --- * **client**: Use the client screen instead of the mouse screen. --- * **mouse**: Use the mouse screen (default). --- -- It is possible to set `awful.screen.default_focused_args` to override the -- default settings. -- --- @tparam[opt={}] table args Some arguments. --- @treturn screen The focused screen object +-- @tparam[opt] table args +-- @tparam[opt=false] table args.client Use the client screen instead of the +-- mouse screen. +-- @treturn ?screen The focused screen object, or `nil` in case no screen is +-- present currently. function screen.focused(args) args = args or screen.default_focused_args or {} return get_screen(args.client and capi.client.screen or capi.mouse.screen)