Merge pull request #13 from dlealv/doc-improvements

documentation improvements

Author: dlealv

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ---
+## [2.1.3] – 2025-07-15
+### Changed
+- Updated `README.md` with minor corrections about extra field output
+- Updated the `README.md` including external function documentation
+
 ## [2.1.2] – 2025-07-12
 ### Fixed
 - Removed the call `this.clearCellIfNotEmpty("")` in `ExcelAppender.constructor` since it produces an error in Office Script indicating: `Unexpected token 'this'`.

README.md

@@ -881,9 +881,10 @@ class LayoutImpl implements Layout {
  * Formats a log event as a short string as follows '[type] message'.
  * If extraFields are present in the event, they will be appended as a JSON object (surrounded by braces) to the output.
  * Example: `[ERROR] Something bad happened {"user":"dlealv","id":42}`.
- * Defined as a named function to ensure toString() returns the function name.
+ * Defined as a named function to ensure `toString()` of `LayoutImpl` returns the function name.
+ * @param event - The log event to format.
+ * @returns A formatted string representation of the log event, as it will be sent to the appenders.
  */
-
 LayoutImpl.shortFormatterFun = Object.freeze(function shortLayoutFormatterFun(event: LogEvent): string {
   const sType = LOG_EVENT[event.type]
   let extraFieldsStr = ""
@@ -898,9 +899,10 @@ LayoutImpl.shortFormatterFun = Object.freeze(function shortLayoutFormatterFun(ev
  * The timestamp is formatted as `YYYY-MM-DD HH:mm:ss,SSS`.
  * If extraFields are present in the event, they will be appended as a JSON object (surrounded by braces) to the  output.
  * Example: `[2025-06-19 15:06:41,123] [ERROR] Something bad happened {"user":"dlealv","id":42}`.
- * Defined as a named function to ensure toString() returns the function name.
+ * Defined as a named function to ensure `toString()` of `LayoutImpl` returns the function name.
+ * @param event - The log event to format.
+ * @returns A formatted string representation of the log event, as it will be sent to the appenders.
  */
-
 LayoutImpl.defaultFormatterFun = Object.freeze(function defaultLayoutFormatterFun(event: LogEvent): string {
   const sDATE = Utility.date2Str(event.timestamp)
   const sType = LOG_EVENT[event.type]