From a76602ec6f5855f9ec42014db82aa5e466300b5f Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Wed, 30 Mar 2022 07:29:43 -0700 Subject: [PATCH] update docs --- docs/eos_flag.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/eos_flag.md b/docs/eos_flag.md index 1fb8e571..9ddbb9f3 100644 --- a/docs/eos_flag.md +++ b/docs/eos_flag.md @@ -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. -- 2.39.5