From 3f566741f708030014a56ad0c69e874db7ec4240 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Mon, 23 Sep 2013 23:25:15 -0400 Subject: Code and documentation cleanup. --- core/events.lua | 2 +- core/file_io.lua | 2 +- core/keys.lua | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) (limited to 'core') diff --git a/core/events.lua b/core/events.lua index 5e830c79..f4461c58 100644 --- a/core/events.lua +++ b/core/events.lua @@ -174,7 +174,7 @@ local M = {} -- * _`alt`_: The "Alt"/"Option" modifier key is held down. -- * _`meta`_: The "Control" modifier key on Mac OSX is held down. -- @field MARGIN_CLICK (string) --- Emitted when clicking the mouse inside a margin. +-- Emitted when clicking the mouse inside a sensitive margin. -- Arguments: -- -- * _`margin`_: The margin number clicked. diff --git a/core/file_io.lua b/core/file_io.lua index 17ca2824..ce3bf8ec 100644 --- a/core/file_io.lua +++ b/core/file_io.lua @@ -184,7 +184,7 @@ function io.reload_file() end --- --- Converts the current buffer's contents to string encoding *encoding*. +-- Converts the current buffer's contents to encoding *encoding*. -- @param encoding The string encoding to set. Valid encodings are ones that GNU -- iconv accepts. -- @usage io.set_buffer_encoding('ASCII') diff --git a/core/keys.lua b/core/keys.lua index bcfc8f7c..2278d247 100644 --- a/core/keys.lua +++ b/core/keys.lua @@ -27,10 +27,10 @@ local M = {} -- ## Key Sequences -- -- Key sequences are strings built from an ordered combination of modifier keys --- and the key itself. Modifier keys are "Control", "Shift", and "Alt" on --- Windows, Linux, BSD, and in curses. On Mac OSX they are "Control" (`^`), --- "Alt/Option" (`⌥`), "Command" (`⌘`), and "Shift" (`⇧`). These modifiers have --- the following string representations: +-- and the key's inserted character. Modifier keys are "Control", "Shift", and +-- "Alt" on Windows, Linux, BSD, and in curses. On Mac OSX they are "Control" +-- (`^`), "Alt/Option" (`⌥`), "Command" (`⌘`), and "Shift" (`⇧`). These +-- modifiers have the following string representations: -- -- Modifier | Linux / Win32 | Mac OSX | curses | -- ---------|---------------|---------|----------| -- cgit v1.2.3