Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation regarding modifier keys. #280

Merged
merged 1 commit into from
Nov 2, 2022
Merged

Added documentation regarding modifier keys. #280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Source/EjectMenu.spoon/init.lua
View file
Open in desktop
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