Skip to content

Commit

Permalink
Added documentation regarding modifier keys. (Hammerspoon#280)
Browse files Browse the repository at this point in the history
Addresses issue Hammerspoon#279
  • Loading branch information
von authored and eraserhd committed Jul 11, 2024
1 parent 7c32b70 commit aad3787
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Source/EjectMenu.spoon/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
--- A much-needed eject menu for your Mac menu bar. Allows ejecting
--- individual or all non-internal disks. Ejection can also be
--- triggered on sleep, on lid close, or using a hotkey.
--- Using the Command key modifier causes the menu to open
--- the given volume in the Finder instead of ejecting it.
---
--- Download: [https://github.com/Hammerspoon/Spoons/raw/master/Spoons/EjectMenu.spoon.zip](https://github.com/Hammerspoon/Spoons/raw/master/Spoons/EjectMenu.spoon.zip)

Expand Down Expand Up @@ -181,7 +183,7 @@ end
-- Initializes eject menu when clicked.
--
-- Parameters
-- * mods: a table containing {mod = bool} for all modifiers, where bool can be be either 'true' or 'false' (unlike execMenuItem)
-- * mods: a table containing {mod = bool} for all modifiers, where bool can be be either 'true' or 'false' (unlike execMenuItem). If a modifier is in effect, the given volume is opened in the Finder rather than ejected.
--
-- Returns
-- * ejectMenuTable: a table containing entries and functions for ejectable drives.
Expand Down

0 comments on commit aad3787

Please sign in to comment.