self review

pgayvallet · pgayvallet · commit 3e740c6ef656 · 2020-12-03T20:23:56.000+01:00
diff --git a/src/core/server/logging/appenders/rolling_file/rolling_file_appender.ts b/src/core/server/logging/appenders/rolling_file/rolling_file_appender.ts
@@ -166,7 +166,7 @@ export class RollingFileAppender implements DisposableAppender {
   }
 
   /**
-   * Checks if the current even should trigger a rollout
+   * Checks if the current event should trigger a rollout
    */
   private needRollout(record: LogRecord) {
     return this.policy.isTriggeringEvent(record);
diff --git a/src/core/server/logging/appenders/rolling_file/strategies/numeric/pattern_matcher.ts b/src/core/server/logging/appenders/rolling_file/strategies/numeric/pattern_matcher.ts
@@ -42,7 +42,7 @@ const createNumericMatcher = (fileBaseName: string, pattern: string): RegExp =>
  * matcher('kibana-1.log') // `1`
  * matcher('kibana-5.log') // `5`
  * matcher('kibana-A.log') // undefined
- * matcher('kibana.log')   // `undefined
+ * matcher('kibana.log')   // undefined
  * ```
  */
 export const getFileNameMatcher = (logFileName: string, pattern: string) => {
diff --git a/src/core/server/logging/appenders/rolling_file/strategies/numeric/rolling_tasks.ts b/src/core/server/logging/appenders/rolling_file/strategies/numeric/rolling_tasks.ts
@@ -28,6 +28,9 @@ export const shouldSkipRollout = async ({ logFilePath }: { logFilePath: string }
   return !(await exists(logFilePath));
 };
 
+/**
+ * Returns the rolled file basenames, from the most recent to the oldest.
+ */
 export const getOrderedRolledFiles = async ({
   logFileBaseName,
   logFileFolder,
diff --git a/src/core/server/logging/appenders/rolling_file/strategies/strategy.ts b/src/core/server/logging/appenders/rolling_file/strategies/strategy.ts
@@ -18,7 +18,7 @@
  */
 
 /**
- * A strategy to perform the log file rollout.
+ * A strategy to perform the log file rollover.
  */
 export interface RollingStrategy {
   /**

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ export class RollingFileAppender implements DisposableAppender {`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`/**`
`169`		`- * Checks if the current even should trigger a rollout`
	`169`	`+ * Checks if the current event should trigger a rollout`
`170`	`170`	`*/`
`171`	`171`	`private needRollout(record: LogRecord) {`
`172`	`172`	`return this.policy.isTriggeringEvent(record);`