]> git.donarmstrong.com Git - perltidy.git/commitdiff
update docs
authorSteve Hancock <perltidy@users.sourceforge.net>
Wed, 30 Mar 2022 14:29:43 +0000 (07:29 -0700)
committerSteve Hancock <perltidy@users.sourceforge.net>
Wed, 30 Mar 2022 14:29:43 +0000 (07:29 -0700)
docs/eos_flag.md

index 1fb8e5711fd12c7aa5189a84aab51b13da23b9f4..9ddbb9f3c2a7e1dc7fd2361a5dab19264640b387 100644 (file)
@@ -189,17 +189,18 @@ destination is a string:
 
 The first three of these may start at either a file or a string, and the last one only starts at a string.
 
-From this we can see that, if **-eos** is set, then only cases 1, 3, and 8 can occur.  In that case the starting and ending states have the same storage mode for all routes through perltidy which end at a string.  This verfies that perltidy will work well as a filter in all cases when **-eos** flag, which is the goal here.
+From this we can see that, if **-eos** is set, then only cases 1, 3, and 8 can occur.  In that case the starting and ending states have the same storage mode for all routes through perltidy which end at a string.  This verfies that perltidy will work well as a filter in all cases when the **-eos** flag is set, which is the goal here.
 
 The last case in this table, the C->C->C route, corresponds to programs which
 pass decoded strings to perltidy. This is a common usage pattern, and this
 route is not influenced by the **-eos** flag setting, since it only applies to
-strings that have been decoded by perltidy itself.  So the full name of the
-flag, **--encode-output-strings**, is not the best because it does not describe
-what happens in this case.  It was difficult to find a concise name for this
-flag.  A more correct name would have been
-**--encode-output-strings-that-you-decode**, but that is rather long.  A more
-intuitive name for the flag might have been **--be-a-nice-filter**.
+strings that have been decoded by perltidy itself.
+
+Incidentally, the full name of the flag, **--encode-output-strings**, is not
+the best because it does not describe what happens in this case.  It was
+difficult to find a concise name for this flag.  A more correct name would have
+been **--encode-output-strings-that-you-decode**, but that is rather long.  A
+more intuitive name for the flag might have been **--be-a-nice-filter**.
 
 Finally, note that case 7 in the full table, the C->C->B route, is an unusual
 but possible situation involving a source string being sent directly to a file.