update docs

Author: Brenton Bostick

CMakeLists.txt

@@ -223,6 +223,9 @@ endforeach()
 # generated srcs
 #
 
+#
+# AcceptableOperators files
+#
 add_custom_command(
 	OUTPUT
 		${PROJECT_BINARY_DIR}/generated/wl/Kernel/AcceptableOperators.wl
@@ -242,6 +245,9 @@ add_custom_command(
 		${PROJECT_SOURCE_DIR}
 )
 
+#
+# CodeFormatter.nb
+#
 add_custom_command(
 	OUTPUT
 		${PROJECT_BINARY_DIR}/generated/wl/FrontEnd/Palettes/CodeFormatter.nb
@@ -258,7 +264,6 @@ add_custom_command(
 )
 
 
-
 #
 # paclet target
 #

CodeFormatter/Kernel/CodeFormatter.wl

@@ -194,7 +194,7 @@ Options[CodeFormat] = {
 
   "TabWidth" :> $DefaultTabWidth,
   "BreakLinesMethod" :> $DefaultBreakLinesMethod,
-  (* Undocumented options for  LineBreakerV1 *)
+  (* Undocumented options for LineBreakerV1 *)
   "SafetyMargin" :> $DefaultSafetyMargin,
 
   PerformanceGoal -> "Speed"

README.md

@@ -61,3 +61,8 @@ Make sure that the paclets can be found on your system:
 ```
 Needs["CodeFormatter`"]
 ```
+
+and try a basic example:
+```
+CodeFormat["If[a, b, c]"]
+```

docs/canonicalization.md

@@ -85,6 +85,7 @@ what are all of the "Preserve" behaviors?
 
 Not all newlines and whitespace are stripped
 
+multi-line comments need to remember original indentation
 
 It is desired that this comment stay at end of line:
 
@@ -110,13 +111,6 @@ This information must be kept track of
 
 
 
-
-
-
-
-
-
-