Linting (lucee#1098)

* format paragraphs

.gitignore

@@ -7,3 +7,4 @@ server/server-luceedocslocalserver.json
 server-luceedocsbuilder.json
 .commandbox
 server/performance.log
+/commandbox-luceedocslocalserver

docs/03.reference/01.functions/ajaxonload/_arguments/functionName.md

@@ -1 +1,3 @@
-The name of the function to run when the page loads. The specified function does not take a parameter.
+The name of the function to run when the page loads.
+
+The specified function does not take a parameter.

docs/03.reference/01.functions/arraytolist/_arguments/delimiter.md

@@ -1 +1,3 @@
-Character or multicharacter string to separate list elements. The default value is comma.
+Character or multicharacter string to separate list elements.
+
+The default value is comma.

docs/03.reference/01.functions/cachedelete/_arguments/throwOnError.md

@@ -1 +1,3 @@
-define if the functions throws an exception when the element does not exist (default is false).
+define if the functions throws an exception when the element does not exist.
+
+Default is false.

docs/03.reference/01.functions/cacheget/_arguments/throwWhenNotExist.md

@@ -1 +1,3 @@
-define if the functions throws an exception when the element does not exist (default is false).
+define if the functions throws an exception when the element does not exist.
+
+Default is false.

docs/03.reference/01.functions/cacheregionnew/_arguments/throwOnError.md

@@ -1 +1,3 @@
-specifies whether the function should throw an exception if a cache connection with that name already exists (default is true)
+specifies whether the function should throw an exception if a cache connection with that name already exists.
+
+Default is true.

docs/03.reference/01.functions/dateconvert/function.md

@@ -8,4 +8,8 @@ description: Converts a date to the given locale.
 
 Converts a date to the given locale.
 
->>>> This function only exists for compatibility reasons and should not be used. The timezone is not part of the datetime object. The function simply add/subtracts the time between the local time and the UTC from the date Object.
+>>>> This function only exists for compatibility reasons and should not be used.
+
+The timezone is not part of the datetime object.
+
+The function simply add/subtracts the time between the local time and the UTC from the date Object.

docs/03.reference/01.functions/directorydelete/_arguments/recurse.md

@@ -1 +1,3 @@
-Delete content of the directory. Default is false.
+Delete content of the directory.
+
+Default is false.

docs/03.reference/01.functions/encodeforurl/_arguments/canonicalize.md

@@ -1 +1,11 @@
-If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.
+If set to true, canonicalization happens before encoding.
+
+If set to false, the given input string will just be encoded.
+
+The default value for canonicalize is false.
+
+When this parameter is not specified, canonicalization will not happen.
+
+By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
+
+To use any other combinations you should canonicalize using canonicalize method and then do encoding.

docs/03.reference/01.functions/encodeforxmlattribute/_arguments/canonicalize.md

@@ -1 +1,9 @@
-If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.
+If set to true, canonicalization happens before encoding. 
+
+If set to false, the given input string will just be encoded. 
+
+The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. 
+
+By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. 
+
+To use any other combinations you should canonicalize using canonicalize method and then do encoding.

docs/03.reference/01.functions/encodeforxpath/_arguments/canonicalize.md

@@ -1 +1,11 @@
-If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.
+If set to true, canonicalization happens before encoding.
+
+If set to false, the given input string will just be encoded.
+
+The default value for canonicalize is false.
+
+When this parameter is not specified, canonicalization will not happen.
+
+By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
+
+To use any other combinations you should canonicalize using canonicalize method and then do encoding.

docs/03.reference/01.functions/esapiencode/_arguments/canonicalize.md

@@ -1,5 +1,11 @@
-If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false.
+If set to true, canonicalization happens before encoding.
 
-When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
+If set to false, the given input string will just be encoded.
+
+The default value for canonicalize is false.
+
+When this parameter is not specified, canonicalization will not happen.
+
+By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
 
 To use any other combinations you should canonicalize using canonicalize method and then do encoding.

docs/03.reference/01.functions/fileseek/function.md

@@ -5,4 +5,6 @@ categories:
 - files
 ---
 
-Shifts the file pointer to the given position. The file must be opened with seekable option
+Shifts the file pointer to the given position.
+
+The file must be opened with seekable option

docs/03.reference/01.functions/find/function.md

@@ -6,5 +6,6 @@ categories:
     - string
 ---
 
-Finds the first occurrence of a substring in a string, from a
-specified start position. The search is case-sensitive.
+Finds the first occurrence of a substring in a string, from a specified start position. 
+
+The search is case-sensitive.

docs/03.reference/01.functions/findnocase/function.md

@@ -6,6 +6,8 @@ categories:
     - string
 ---
 
-Finds the first occurrence of a substring in a string, from a
-specified start position. If substring is not in string,
-returns zero. The search is case-insensitive.
+Finds the first occurrence of a substring in a string, from a specified start position.
+
+If substring is not in string, returns zero.
+
+The search is case-insensitive.

docs/03.reference/01.functions/findoneof/function.md

@@ -6,6 +6,6 @@ categories:
     - string
 ---
 
-Finds the first occurrence of any one of a set of characters
-in a string, from a specified start position. The search is
-case-sensitive.
+Finds the first occurrence of any one of a set of characters in a string, from a specified start position.
+
+The search is case-sensitive.

docs/03.reference/01.functions/firstdayofmonth/_arguments/timezone.md

@@ -2,7 +2,9 @@ A datetime object is independent of a specific timezone; it is only an offset in
 
 The timezone only comes into play when you need specific information like hours in a day, minutes in a hour or which day it is as these calculations depend on the timezone.
 
-A timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function [[function-setTimezone|setTimezone()]].
+A timezone must be specified in order to translate the date object to something else. 
+
+If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function [[function-setTimezone|setTimezone()]].
 
 You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include:
 

docs/03.reference/01.functions/getapplicationsettings/_arguments/suppressFunction.md

@@ -1 +1,3 @@
-If true then only data members from this scope are returned (no functions), default is false.  Calling this function and passing `true` is equivalent to calling `getApplicationMetaData()`
+If true then only data members from this scope are returned (no functions), default is false.
+
+Calling this function and passing `true` is equivalent to calling `getApplicationMetaData()`

docs/03.reference/01.functions/getbasetagdata/_arguments/instancenumber.md

@@ -1 +1,3 @@
-Number of ancestor levels to jump before returning data. The default value is 1 (closest ancestor).
+Number of ancestor levels to jump before returning data.
+
+The default value is 1 (closest ancestor).

docs/03.reference/01.functions/getfreespace/function.md

@@ -9,4 +9,10 @@ description: Returns the number of unallocated bytes in the partition named by t
 
 Returns the number of unallocated bytes in the partition named by this abstract path name.
 
-The returned number of unallocated bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes. The number of unallocated bytes is most likely to be accurate immediately after this call. It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this virtual machine. This method makes no guarantee that write operations to this file system will succeed.
+The returned number of unallocated bytes is a hint, but not a guarantee, that it is possible to use most or any of these bytes.
+
+The number of unallocated bytes is most likely to be accurate immediately after this call.
+
+It is likely to be made inaccurate by any external I/O operations including those made on the system outside of this virtual machine.
+
+This method makes no guarantee that write operations to this file system will succeed.

docs/03.reference/01.functions/gethttprequestdata/_arguments/includeBody.md

@@ -1 +1,3 @@
-You would like to retrieve the body of the request as well (true or false). Default is true.
+You would like to retrieve the body of the request as well (true or false). 
+
+Default is true.

docs/03.reference/01.functions/hmac/function.md

@@ -6,4 +6,8 @@ categories:
 description: 'Creates a hash-based message authentication code (HMAC) '
 ---
 
-Creates a hash-based message authentication code (HMAC) for the given message combined with a given secret key using an optional algorithm and encoding. HMACs are used to verify the data integrity and authenticity of a transmitted message. The hash function used by the HMAC function depends on the algorithm specified.
+Creates a hash-based message authentication code (HMAC) for the given message combined with a given secret key using an optional algorithm and encoding.
+
+HMACs are used to verify the data integrity and authenticity of a transmitted message.
+
+The hash function used by the HMAC function depends on the algorithm specified.

docs/03.reference/01.functions/imagegetblob/function.md

@@ -6,4 +6,6 @@ categories:
     - image
 ---
 
-Retrieves the bytes of the underlying image. The bytes are in the same image format as the source image.
+Retrieves the bytes of the underlying image.
+
+The bytes are in the same image format as the source image.

docs/03.reference/01.functions/imagesetbackgroundcolor/function.md

@@ -6,4 +6,8 @@ categories:
     - image
 ---
 
-Sets the background color for the image. The background color is used for clearing a region. Setting the background color only affects the subsequent ImageClearRect calls
+Sets the background color for the image.
+
+The background color is used for clearing a region.
+
+Setting the background color only affects the subsequent ImageClearRect calls

docs/03.reference/01.functions/inputbasen/function.md

@@ -6,5 +6,5 @@ categories:
     - number
 ---
 
-Converts string, using the base specified by radix, to an
-integer. For example: #InputBaseN("3ff",16)#
+Converts string, using the base specified by radix, to an integer.
+For example: #InputBaseN("3ff",16)#

docs/03.reference/01.functions/insert/function.md

@@ -6,6 +6,6 @@ categories:
     - string
 ---
 
-Inserts a substring in a string after a specified character
-position. If position = 0, prefixes the substring to the
-string.
+Inserts a substring in a string after a specified character position. 
+
+If position = 0, prefixes the substring to the string.

docs/03.reference/01.functions/isimagefile/_arguments/path.md

@@ -1 +1,3 @@
-The pathname of the file to be checked. The pathname can be absolute or relative to the CFM page and must be enclosed in quotation marks.
+The pathname of the file to be checked.
+
+The pathname can be absolute or relative to the CFM page and must be enclosed in quotation marks.

docs/03.reference/01.functions/listchangedelims/_arguments/multiCharacterDelimiter.md

@@ -2,4 +2,4 @@ specifying whether the delimiters parameter specifies a multi-character delimite
 
 If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.
 
-This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+This parameter enables the [[function-ListToArray]] function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listcompact/_arguments/multiCharacterDelimiter.md

@@ -1 +1,5 @@
-specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+specifying whether the delimiters parameter specifies a multi-character delimiter. 
+
+If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.
+
+This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listcontains/_arguments/multiCharacterDelimiter.md

@@ -1 +1,5 @@
-specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+specifying whether the delimiters parameter specifies a multi-character delimiter. 
+
+If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. 
+
+This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listcontainsnocase/_arguments/multiCharacterDelimiter.md

@@ -1 +1,5 @@
-specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+specifying whether the delimiters parameter specifies a multi-character delimiter.
+
+If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.
+
+This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listfilter/_arguments/multiCharacterDelimiter.md

@@ -1 +1,5 @@
-specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+specifying whether the delimiters parameter specifies a multi-character delimiter.
+
+If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.
+
+This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listsome/_arguments/multiCharacterDelimiter.md

@@ -1 +1,5 @@
-specifying whether the delimiters parameter specifies a multi-character delimiter. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.
+specifying whether the delimiters parameter specifies a multi-character delimiter.
+
+If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters.
+
+This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.

docs/03.reference/01.functions/listtoarray/_arguments/includeEmptyFields.md

@@ -1 +1,3 @@
-If set to true, empty values are also included. Default is false.
+If set to true, empty values are also included. 
+
+Default is false.

docs/03.reference/01.functions/listvaluecount/function.md

@@ -7,5 +7,6 @@ categories:
     - string
 ---
 
-Counts instances of a specified value in a list. The search is
-case-sensitive.
+Counts instances of a specified value in a list. 
+
+The search is case-sensitive.

docs/03.reference/01.functions/listvaluecountnocase/function.md

@@ -7,5 +7,6 @@ categories:
     - string
 ---
 
-Counts instances of a specified value in a list. The search is
-case-insensitive.
+Counts instances of a specified value in a list.
+
+The search is case-insensitive.

docs/03.reference/01.functions/lstimeformat/_arguments/mask.md

@@ -1 +1,5 @@
-Mask that has to be used for formatting. The function follows Java date time mask. For details, see the Java documentation section [Date and Time Patterns](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html).
+Mask that has to be used for formatting.
+
+The function follows Java date time mask.
+
+For details, see the Java documentation section [Date and Time Patterns](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html).

docs/03.reference/01.functions/lstimeformat/_arguments/timezone.md

@@ -2,7 +2,9 @@ A datetime object is independent of a specific timezone; it is only an offset in
 
 The timezone only comes into play when you need specific information like hours in a day, minutes in a hour or which day it is as these calculations depend on the timezone.
 
-A timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function [[function-setTimezone|setTimezone()]].
+A timezone must be specified in order to translate the date object to something else.
+
+If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function [[function-setTimezone|setTimezone()]].
 
 You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones include: