Skip to content

Commit eb067bc

Browse files
committed
Reduce width of docstrings below limit of 80 characters
> lua-mode.el:378:9: Warning: defvar ‘lua-electric-flag’ docstring > wider than 80 characters > lua-mode.el:1035:11: Warning: defconst ‘lua-block-token-alist’ > docstring wider than 80 characters > In lua-is-continuing-statement-p: > lua-mode.el:1444:2: Warning: docstring wider than 80 characters
1 parent d074e41 commit eb067bc

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

lua-mode.el

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,8 @@ If the latter is nil, the keymap translates into `lua-mode-map' verbatim.")
376376
"Keymap used in lua-mode buffers.")
377377

378378
(defvar lua-electric-flag t
379-
"If t, electric actions (like automatic reindentation) will happen when an electric
380-
key like `{' is pressed")
379+
"If t, electric actions will happen when an electric key like `{' is pressed.
380+
Automatic reindentation is an example of an electric action.")
381381
(make-variable-buffer-local 'lua-electric-flag)
382382

383383
(defcustom lua-prompt-regexp "[^\n]*\\(>[\t ]+\\)+$"
@@ -1054,9 +1054,15 @@ found, returns point position, nil otherwise."
10541054
Each token information entry is of the form:
10551055
KEYWORD FORWARD-MATCH-REGEXP BACKWARDS-MATCH-REGEXP TOKEN-TYPE
10561056
KEYWORD is the token.
1057-
FORWARD-MATCH-REGEXP is a regexp that matches all possible tokens when going forward.
1058-
BACKWARDS-MATCH-REGEXP is a regexp that matches all possible tokens when going backwards.
1059-
TOKEN-TYPE determines where the token occurs on a statement. open indicates that the token appears at start, close indicates that it appears at end, middle indicates that it is a middle type token, and middle-or-open indicates that it can appear both as a middle or an open type.")
1057+
FORWARD-MATCH-REGEXP is a regexp that matches all possible tokens
1058+
when going forward.
1059+
BACKWARDS-MATCH-REGEXP is a regexp that matches all possible tokens
1060+
when going backwards.
1061+
TOKEN-TYPE determines where the token occurs on a statement. `open'
1062+
indicates that the token appears at start, close indicates that it
1063+
appears at end, `middle' indicates that it is a middle type token,
1064+
and `middle-or-open' indicates that it can appear both as a middle
1065+
or an open type.")
10601066

10611067
(defconst lua-indentation-modifier-regexp
10621068
;; The absence of else is deliberate, since it does not modify the
@@ -1442,14 +1448,12 @@ The criteria for a continuing statement are:
14421448

14431449

14441450
(defun lua-is-continuing-statement-p (&optional parse-start)
1445-
"Returns non-nil if the line at PARSE-START should be indented as continuation line.
1451+
"Return non-nil if line at PARSE-START is a continuation line.
14461452
1447-
This true is when the line :
1448-
1449-
* is continuing a statement itself
1450-
1451-
* starts with a 1+ block-closer tokens, an top-most block opener is on a continuation line
1452-
"
1453+
This affects how it should be indented. A line is a continuation line if
1454+
- it is continuing a statement itself, or
1455+
- it starts with a 1+ block-closer tokens, an top-most block opener is on
1456+
a continuation line."
14531457
(save-excursion
14541458
(if parse-start (goto-char parse-start))
14551459

0 commit comments

Comments
 (0)