Skip to content

Commit ad3f726

Browse files
committed
Updated README
1 parent 9ae3e9c commit ad3f726

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Why waste your valuable development time formatting code manually when we are tr
33

44
The repo contains an auto formatting script for the [ROS C++ Style Guidelines](http://wiki.ros.org/CppStyleGuide).
55

6-
> **Note: this style is in beta format as its only been tested by Dave Coleman**
6+
> **Note: this style is in beta format, please submit suggestions or fixes!**
77
88
## Setup
99

@@ -43,7 +43,7 @@ Format your source code if its in some directory such as the ``catkin_ws`` (feel
4343

4444
```
4545
(defun run-ros-clang-format ()
46-
"Runs clang-format on cpp,hpp files in catkin_ws/ and reverts buffer."
46+
"Runs clang-format on cpp,h files in catkin_ws/ and reverts buffer."
4747
(interactive)
4848
(and
4949
(string-match "/catkin_ws/.*\\.\\(h\\|cpp\\)$" buffer-file-name)
@@ -55,7 +55,9 @@ Format your source code if its in some directory such as the ``catkin_ws`` (feel
5555

5656
Set a keyboard shortcut to run, such as F12
5757

58-
(global-set-key [f12] 'maybe-run-ros-clang-format)
58+
(global-set-key [f12] 'run-ros-clang-format)
59+
60+
Note: be sure to save your buffer before running this script, as it will overwrite unsaved changes. This caveat shouldn't be hard to fix.
5961

6062
### Atom Editor Configuration
6163

0 commit comments

Comments
 (0)