Browse Source

docs(core): Escape "@" in example import statements

Michael Bromley 6 years ago
parent
commit
0470e03c84

+ 1 - 1
packages/core/src/config/logger/default-logger.ts

@@ -12,7 +12,7 @@ const DEFAULT_CONTEXT = 'Vendure Server';
  *
  * @example
  * ```ts
- * import { DefaultLogger, LogLevel, VendureConfig } from '@vendure/core';
+ * import { DefaultLogger, LogLevel, VendureConfig } from '\@vendure/core';
  *
  * export config: VendureConfig = {
  *     // ...

+ 2 - 2
packages/core/src/config/logger/vendure-logger.ts

@@ -49,7 +49,7 @@ const noopLogger: VendureLogger = {
  *
  * @example
  * ```ts
- * import { Logger } from '@vendure/core';
+ * import { Logger } from '\@vendure/core';
  *
  * Logger.info(`Some log message`, 'My Vendure Plugin');
  * ```
@@ -66,7 +66,7 @@ const noopLogger: VendureLogger = {
  *
  * @example
  * ```ts
- * import { VendureLogger } from '@vendure/core';
+ * import { VendureLogger } from '\@vendure/core';
  * import fs from 'fs';
  *
  * // A simple custom logger which writes all logs to a file.