branch: scratch/editorconfig-cc
commit cdbd60a8a6d8a36be186d4811d9ec1ff292a606a
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
M-x checkdoc
---
editorconfig-core-handle.el | 2 +-
editorconfig.el | 17 ++++++++++++-----
2 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/editorconfig-core-handle.el b/editorconfig-core-handle.el
index c22172b56d..3cfae15501 100644
--- a/editorconfig-core-handle.el
+++ b/editorconfig-core-handle.el
@@ -53,7 +53,7 @@ Slots:
(props nil))
(defun editorconfig-core-handle-section-get-properties (section file dir)
- "Return properties alist when SECTION name matches FILE.
+ "Return properties alist when SECTION name match FILE.
DIR should be where the directory where .editorconfig which has SECTION exists.
IF not match, return nil."
diff --git a/editorconfig.el b/editorconfig.el
index cee7392b79..fbaad7fdff 100644
--- a/editorconfig.el
+++ b/editorconfig.el
@@ -133,7 +133,7 @@ overwrite \"indent_style\" property when current
`major-mode' is a
:group 'editorconfig)
(defcustom editorconfig-indentation-alist
- ;; For contributors: Sort modes in alphabetical order, please :)
+ ;; For contributors: Sort modes in alphabetical order
'((apache-mode apache-indent-level)
(awk-mode c-basic-offset)
(c++-mode c-basic-offset)
@@ -243,8 +243,7 @@ NOTE: Only the **buffer local** value of VARIABLE will be
set."
(defcustom editorconfig-exclude-regexps
(list (eval-when-compile
(rx string-start (or "http" "https" "ftp" "sftp" "rsync") ":")))
- "List of buffer filename prefix regexp patterns not to apply
-properties."
+ "List of buffer filename prefix regexp patterns not to apply properties."
:type '(repeat string)
:group 'editorconfig)
@@ -330,6 +329,13 @@ number - `lisp-indent-offset' is not set only if
indent_size is
eol)
nil t))))
+(defun editorconfig-set-trailing-nl (final-newline)
+ "Set up requiring final newline by FINAL-NEWLINE.
+
+This function will set `require-final-newline' and `mode-require-final-newline'
+to non-nil when FINAL-NEWLINE is true."
+ )
+
(defun editorconfig-set-trailing-ws (trim-trailing-ws)
(if editorconfig-trim-whitespaces-mode
(funcall editorconfig-trim-whitespaces-mode 1)
@@ -428,8 +434,9 @@ EXT should be a string like `\"ini\"`, if not nil or empty
string."
)
(defun editorconfig-get-properties-from-exec ()
- "Get EditorConfig properties of current buffer by calling
-`editorconfig-exec-path'."
+ "Get EditorConfig properties of current buffer.
+
+This function uses value of `editorconfig-exec-path' to get properties."
(if (executable-find editorconfig-exec-path)
(editorconfig-parse-properties (editorconfig-call-editorconfig-exec))
(error "Unable to find editorconfig executable")))
