Merge: share/man: Update man for `nitpretty`
authorJean Privat <jean@pryen.org>
Wed, 22 Apr 2015 04:18:41 +0000 (11:18 +0700)
committerJean Privat <jean@pryen.org>
Wed, 22 Apr 2015 04:18:41 +0000 (11:18 +0700)
Fixes #1130

Pull-Request: #1290
Reviewed-by: Alexis Laferrière <alexis.laf@xymus.net>
Reviewed-by: Jean Privat <jean@pryen.org>

share/man/nitpretty.md
src/nitpretty.nit

index 0864629..2a023e5 100644 (file)
@@ -25,6 +25,22 @@ nitpretty [*options*]... FILE
 `--check`
 :   Check format of Nit source files
 
+    This option creates a temporary pretty printed file then checks if the output
+    of the diff command on the source file and the pretty printed one is empty.
+
+`--break-strings`
+:   Break too long string literals
+
+`--inline-do`
+:   Force do keyword on the same line as the method signature
+
+`--skip-empty`
+:   Force formatting of empty lines
+
+    By default empty lines are kept as they were typed in the file.
+    When enabling this option, `nitpretty` will decide where to break lines and
+    will put empty lines to separate properties and code blocks.
+
 # SPECIFICATION
 
 The specification of the pretty printing is described here.
index d759992..9667f81 100644 (file)
@@ -48,9 +48,9 @@ redef class ToolContext
 
        # Check formatting instead of pretty printing.
        #
-       # This option create a tempory pretty printed file then check if
-       # the output of the diff command on the source file and the pretty
-       # printed one is empty.
+       # This option creates a temporary pretty printed file then checks if the
+       # output of the diff command on the source file and the pretty printed one is
+       # empty.
        var opt_check = new OptionBool("Check format of Nit source files", "--check")
 end