readme updated

[etc/awesome.git] / widgets / contrib / redshift.lua

diff --git a/widgets/contrib/redshift.lua b/widgets/contrib/redshift.lua
index 38f1d83f48b26a91952072871b3e82c0fee18734..5ed930026d23fcb210e315f3773af1e2ee53b5a8 100644 (file)
--- a/widgets/contrib/redshift.lua
+++ b/widgets/contrib/redshift.lua
@@ -1,25 +1,25 @@
 
 --[[
 
 --[[

-                                                   
-     Licensed under GNU General Public License v2  
-      * (c) 2014, blueluke <http://github.com/blueluke>
-                                                   
+                                                        
+     Licensed under GNU General Public License v2       
+      * (c) 2014, blueluke <http://github.com/blueluke> 
+                                                        

 --]]
 
 --]]
 

-local os = os
-local awful = require("awful")
-local spawn = awful.util.spawn_with_shell
+local awful        = require("awful")
+local os           = os
+local spawn        = awful.util.spawn_with_shell

 
 local setmetatable = setmetatable
 
 
 local setmetatable = setmetatable
 

--- redshift
+-- Redshift

 -- lain.widgets.contrib.redshift
 local redshift = {}
 
 -- lain.widgets.contrib.redshift
 local redshift = {}
 

-local attached = false                       -- true if attached to a widget
-local active = false                         -- true if redshift is active            
-local running = false                        -- true if redshift was initialized 
-local update_fnct = function() end           -- function that is run each time redshift is toggled. See redshift:attach().
+local attached = false             -- true if attached to a widget
+local active = false               -- true if redshift is active
+local running = false              -- true if redshift was initialized
+local update_fnct = function() end -- Function that is run each time redshift is toggled. See redshift:attach().

 
 
 local function init()
 
 
 local function init()


@@ -35,11 +35,11 @@ local function init()
 end
 
 function redshift:toggle()
 end
 
 function redshift:toggle()

-    if running then 
+    if running then

         -- Sending -USR1 toggles redshift (See project website)
         os.execute("pkill -USR1 redshift")
         active = not active
         -- Sending -USR1 toggles redshift (See project website)
         os.execute("pkill -USR1 redshift")
         active = not active

-    else 
+    else

         init()
     end
     update_fnct()
         init()
     end
     update_fnct()


@@ -63,9 +63,9 @@ end
 
 -- Attach to a widget
 -- Provides a button which toggles redshift on/off on click
 
 -- Attach to a widget
 -- Provides a button which toggles redshift on/off on click

--- @ param widget:  widget to attach to
--- @ param fnct:  function to be run each time redshift is toggled (optional).
---                         Use it to update widget text or icons on status change.
+-- @param widget:  Widget to attach to.
+-- @param fnct:    Function to be run each time redshift is toggled (optional).
+--                 Use it to update widget text or icons on status change.

 function redshift:attach(widget, fnct)
     update_fnct  = fnct or function() end
     if not attached then
 function redshift:attach(widget, fnct)
     update_fnct  = fnct or function() end
     if not attached then