[PATCH] D37903: Fix assume-filename handling in clang-format.el

Philipp via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Sep 25 05:04:49 PDT 2017


phst added inline comments.


================
Comment at: tools/clang-format/clang-format.el:123
+(defun clang-format-region (start end &optional style assume-file-name)
+  "Use clang-format to format the code between START and END according to STYLE
+using ASSUME-FILE-NAME to locate a style config file. If called interactively
----------------
Please stick to the canonical format, i.e. the first line should be a complete sentence. See https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html. You can use M-x checkdoc to detect such style issues automatically.
Here I'd just leave the docstring intact and add another sentence describing ASSUME-FILE-NAME at the end.


================
Comment at: tools/clang-format/clang-format.el:157
+                               ;; Gaurd against a nil assume-file-name.
+                               ;; If -assume-filename is given a blank string
+                               ;; it will crash as per the following bug report
----------------
nit: "-assume-file-name"


================
Comment at: tools/clang-format/clang-format.el:194
+(defun clang-format-buffer (&optional style assume-file-name)
+  "Use clang-format to format the current buffer according to STYLE using
+ASSUME-FILE-NAME to locate a style config file. If no style is given uses
----------------
Same here, please make the first line a complete sentence.


https://reviews.llvm.org/D37903





More information about the cfe-commits mailing list