fix: adjust more docs

Author: unional

.changeset/silver-radios-smile.md

@@ -0,0 +1,9 @@
+---
+'standard-log-color': patch
+'standard-log': patch
+---
+
+Adjust jsdoc.
+
+Remove the `import { ... } from 'standard-log'` from the examples.
+This allows the type and docs to be reused when other packages exports the types or instances.

packages/color/ts/supportColor.ts

@@ -31,8 +31,8 @@ let value: supportColor.Result
 /**
  * Detects if the platform supports color.
  * For browser, the value can only be:
- * - `{ stdout: 0, stderr: 0 }`, or
- * - `{ stdout: 3, stderr: 3 }`.
+ * - `{ stdout: 0, stderr: 0 }` (DISABLED), or
+ * - `{ stdout: 3, stderr: 3 }` (TRUE).
  * So you only need to check one case.
  * The result value is made the same so that it can be used in all platforms.
  */

packages/color/ts/types.ts

@@ -7,10 +7,18 @@ export type CssFormatterOptions = {
 	 * Default to 20.
 	 */
 	maxColor?: number
+  /**
+   * Style of the timestamp.
+   * Defaults to `none`.
+   *
+   * - `none`: no timestamp.
+   * - `iso`: in iso format.
+   * - `long`: as elapsed time.
+   */
 	timestamp?: TimestampFormat
 	/**
 	 * style of the id block.
-	 * Defaults to `padding: 2px; margin: 2px; line-height: 1.8em;`
+	 * Defaults to `padding: 2px; line-height: 1rem;`
 	 */
 	style?: string
 }
@@ -19,7 +27,7 @@ export type ColorLogReporterOptions = ConsoleLogReporterOptions & {
 	/**
 	 * CSS formatter options.
 	 * This can be used to specify the CSS formatter options in the browser,
-	 * IF you do not specify your own `formatter`.
+	 * If you do not specify your own `formatter`.
 	 */
 	cssFormatterOptions?: CssFormatterOptions
 }

packages/log/ts/types.ts

@@ -89,9 +89,6 @@ export interface StandardLogInstance<N extends string = LogMethodNames> {
 	 * Get a logger instance with the specified id.
 	 *
 	 * ```ts
-	 * import { createStandardLog } from 'standard-log'
-	 *
-	 * const sl = createStandardLog()
 	 * const logger = sl.getLogger('my-logger')
 	 *
 	 * logger.info('Hello world!') // 2020-01-01T00:00:00.000Z my-logger (INFO) Hello world!
@@ -101,15 +98,12 @@ export interface StandardLogInstance<N extends string = LogMethodNames> {
 	/**
 	 * Get a non-console logger instance with the specified id.
 	 *
-	 * The resulting logger will only write to the reporters that are not console reporters.
+	 * The resulting logger will only send to the reporters that are not console reporters.
 	 *
 	 * ```ts
-	 * import { createStandardLog } from 'standard-log'
-	 *
-	 * const sl = createStandardLog({ reporter: [createConsoleReporter(), createRemoteReporter(...)] })
 	 * const logger = sl.getNonConsoleLogger('my-logger')
 	 *
-	 * logger.info('Hello world!') // will only write to remote reporter
+	 * logger.info('Hello world!') // will not send to any console reporter
 	 * ```
 	 */
 	getNonConsoleLogger(id: string, options?: LoggerOptions): Logger<N | LogMethodNames>