From: Kevin Day <thekevinday@gmail.com>
Date: Fri, 6 May 2022 05:37:52 +0000 (-0500)
Subject: Cleanup: Expand newline into two words and expand EOL into more descriptive terminology.
X-Git-Tag: 0.5.10~165
X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=38ba73880e79988b1ffb6517fd4f870b88a43e33;p=fll

Cleanup: Expand newline into two words and expand EOL into more descriptive terminology.
---

diff --git a/level_3/fss_basic_list_read/c/fss_basic_list_read.c b/level_3/fss_basic_list_read/c/fss_basic_list_read.c
index beb3af3..4d2ddde 100644
--- a/level_3/fss_basic_list_read/c/fss_basic_list_read.c
+++ b/level_3/fss_basic_list_read/c/fss_basic_list_read.c
@@ -88,7 +88,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_basic_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_basic_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
diff --git a/level_3/fss_basic_list_write/c/private-write.h b/level_3/fss_basic_list_write/c/private-write.h
index dac0b4d..f559e9f 100644
--- a/level_3/fss_basic_list_write/c/private-write.h
+++ b/level_3/fss_basic_list_write/c/private-write.h
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_basic_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/fss_basic_write/c/private-write.h b/level_3/fss_basic_write/c/private-write.h
index 74f8c1b..160c048 100644
--- a/level_3/fss_basic_write/c/private-write.h
+++ b/level_3/fss_basic_write/c/private-write.h
@@ -37,7 +37,7 @@ extern "C" {
 #endif // _di_fss_basic_write_error_parameter_value_missing_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/fss_embedded_list_read/c/fss_embedded_list_read.c b/level_3/fss_embedded_list_read/c/fss_embedded_list_read.c
index 83474b2..b73519f 100644
--- a/level_3/fss_embedded_list_read/c/fss_embedded_list_read.c
+++ b/level_3/fss_embedded_list_read/c/fss_embedded_list_read.c
@@ -88,13 +88,11 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_embedded_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: (default) Apply all delimits.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_all_s, context.set.notable, f_string_eol_s);
-    // @todo
-    //fl_print_format("  - %[%r%]: Apply delimits for Objects.%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_object, context.set.notable, f_string_eol_s);
     fl_print_format("  - A number, 0 or greater: apply delimits for Content at the specified depth.%r", file.stream, f_string_eol_s);
     fl_print_format("  - A number, 0 or greater, followed by a %[%r%]: (such as '1+') apply delimits for Content at the specified depth and any greater depth (numerically).%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_greater_s, context.set.notable, f_string_eol_s, f_string_eol_s);
     fl_print_format("  - A number, 0 or lesser, followed by a %[%r%]: (such as '1-') apply delimits for Content at the specified depth and any lesser depth (numerically).%r%r", file.stream, context.set.notable, fss_embedded_list_read_delimit_mode_name_lesser_s, context.set.notable, f_string_eol_s, f_string_eol_s);
diff --git a/level_3/fss_embedded_list_write/c/private-write.h b/level_3/fss_embedded_list_write/c/private-write.h
index 30fba16..e02103b 100644
--- a/level_3/fss_embedded_list_write/c/private-write.h
+++ b/level_3/fss_embedded_list_write/c/private-write.h
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_embedded_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/fss_extended_list_read/c/fss_extended_list_read.c b/level_3/fss_extended_list_read/c/fss_extended_list_read.c
index 7deb02d..b18f5ce 100644
--- a/level_3/fss_extended_list_read/c/fss_extended_list_read.c
+++ b/level_3/fss_extended_list_read/c/fss_extended_list_read.c
@@ -88,7 +88,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_extended_list_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_extended_list_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
diff --git a/level_3/fss_extended_list_write/c/private-write.h b/level_3/fss_extended_list_write/c/private-write.h
index 4f54ee7..5bb5af0 100644
--- a/level_3/fss_extended_list_write/c/private-write.h
+++ b/level_3/fss_extended_list_write/c/private-write.h
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_extended_list_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/fss_extended_write/c/private-write.h b/level_3/fss_extended_write/c/private-write.h
index 9226487..6cce9e1 100644
--- a/level_3/fss_extended_write/c/private-write.h
+++ b/level_3/fss_extended_write/c/private-write.h
@@ -45,7 +45,7 @@ extern "C" {
 #endif // _di_fss_extended_write_error_parameter_value_missing_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter a New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/fss_payload_read/c/fss_payload_read.c b/level_3/fss_payload_read/c/fss_payload_read.c
index 6725c43..3d363d5 100644
--- a/level_3/fss_payload_read/c/fss_payload_read.c
+++ b/level_3/fss_payload_read/c/fss_payload_read.c
@@ -97,7 +97,7 @@ extern "C" {
     fl_print_format("  When specifying both the %[%r%r%]", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_object_s, context.set.notable);
     fl_print_format(" parameter and the %[%r%r%] parameter, the entire Object and Content are printed, including the formatting.%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_content_s, context.set.notable, f_string_eol_s);
     fl_print_format("  Both the Object and Content printed are already escaped.%r", file.stream, f_string_eol_s);
-    fl_print_format("  Both the Object and Content are separated by an EOL.%r%r", file.stream, f_string_eol_s, f_string_eol_s);
+    fl_print_format("  Both the Object and Content are separated by a New Line character '\\n' (U+000A).%r%r", file.stream, f_string_eol_s, f_string_eol_s);
 
     fl_print_format("  The parameter %[%r%r%] accepts the following:%r", file.stream, context.set.notable, f_console_symbol_long_enable_s, fss_payload_read_long_delimit_s, context.set.notable, f_string_eol_s);
     fl_print_format("  - %[%r%]: Do not apply delimits.%r", file.stream, context.set.notable, fss_payload_read_delimit_mode_name_none_s, context.set.notable, f_string_eol_s);
diff --git a/level_3/fss_payload_write/c/private-write.h b/level_3/fss_payload_write/c/private-write.h
index f4d673b..5681e00 100644
--- a/level_3/fss_payload_write/c/private-write.h
+++ b/level_3/fss_payload_write/c/private-write.h
@@ -23,7 +23,7 @@ extern "C" {
 #endif // _di_fss_payload_write_error_parameter_same_times_print_
 
 /**
- * Print an message about a parameter EOL being unsupported.
+ * Print an message about a parameter New Line character '\n' (U+000A) being unsupported.
  *
  * @param main
  *   The main program data.
diff --git a/level_3/iki_read/c/iki_read.c b/level_3/iki_read/c/iki_read.c
index e29070d..0ebb649 100644
--- a/level_3/iki_read/c/iki_read.c
+++ b/level_3/iki_read/c/iki_read.c
@@ -478,7 +478,7 @@ extern "C" {
       status = F_status_set_error(F_parameter);
     }
 
-    // Ensure a newline is always put at the end of the program execution, unless in quiet mode.
+    // Ensure a new line is always put at the end of the program execution, unless in quiet mode.
     if (main->error.verbosity != f_console_verbosity_quiet_e) {
       if (F_status_is_error(status) || !data.mode) {
         if (F_status_set_fine(status) == F_interrupt) {
diff --git a/level_3/iki_write/c/iki_write.c b/level_3/iki_write/c/iki_write.c
index 98b4032..0e5ce83 100644
--- a/level_3/iki_write/c/iki_write.c
+++ b/level_3/iki_write/c/iki_write.c
@@ -390,7 +390,7 @@ extern "C" {
             object_ended = F_true;
           }
 
-          // restore the range, positioned after the newline.
+          // Restore the range, positioned after the new line.
           range.start = range.stop + 2;
           range.stop = buffer.used - 1;
 
@@ -435,7 +435,7 @@ extern "C" {
           fll_print_dynamic_raw(f_string_eol_s, file.stream);
         } // for
 
-        // Ensure there is always a newline at the end, unless in quiet mode.
+        // Ensure there is always a new line at the end, unless in quiet mode.
         if (F_status_is_error_not(status) && main->error.verbosity != f_console_verbosity_quiet_e && main->parameters.array[iki_write_parameter_file_e].result == f_console_result_none_e) {
           fll_print_dynamic_raw(f_string_eol_s, file.stream);
         }
@@ -450,7 +450,7 @@ extern "C" {
       }
     }
 
-    // Ensure a newline is always put at the end of the program execution, unless in quiet mode.
+    // Ensure a new line is always put at the end of the program execution, unless in quiet mode.
     if (main->error.verbosity != f_console_verbosity_quiet_e) {
       if (F_status_is_error(status)) {
         if (F_status_set_fine(status) == F_interrupt) {