branch: externals/matlab-mode
commit 7ef44f745f1545877c4f825cc7c1ade22aaf4634
Author: John Ciolfi <[email protected]>
Commit: John Ciolfi <[email protected]>
doc/matlab-code-indent.org: minor update
---
doc/matlab-code-indent.org | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/doc/matlab-code-indent.org b/doc/matlab-code-indent.org
index 5fe4319b57..d450885e06 100644
--- a/doc/matlab-code-indent.org
+++ b/doc/matlab-code-indent.org
@@ -186,6 +186,21 @@ directives.
end
#+end_src
+ The documentation help comment for a function is not indented. Comments for
code are indented at
+ the level of the code. The help comment is the comment immediately
following the function
+ statement (no blank lines). Example:
+
+ #+begin_src matlab
+ function out = foobar(in)
+ % FOOBAR - this is the H1 line of the help
+ % This is additional help info.
+ % This comment is not indented.
+
+ % this is a comment for the following code
+ out = 2 * in;
+ end
+ #+end_src
+
2. *Recommended line length 100*
Code and comments should fit within 100 columns. A line may exceed 100
characters if it improves
