docs: fix typo in code comments (#11944)

Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
withastro · Sep 25, 2024 · 98831ee · 98831ee
1 parent 7814a6c
commit 98831ee
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts
@@ -813,7 +813,7 @@ export interface AstroUserConfig {
 	/**
 	 * @docs
 	 * @name security
-	 * @type {boolean}
+	 * @type {object}
 	 * @default `{}`
 	 * @version 4.9.0
 	 * @description
@@ -838,7 +838,7 @@ export interface AstroUserConfig {
 		 * @name security.checkOrigin
 		 * @kind h4
 		 * @type {boolean}
-		 * @default 'false'
+		 * @default `false`
 		 * @version 4.9.0
 		 * @description
 		 *
@@ -1088,7 +1088,7 @@ export interface AstroUserConfig {
 		 * ```js
 		 * {
 		 * 	build: {
-		 *		inlineStylesheets: `never`,
+		 *		inlineStylesheets: 'never',
 		 * 	},
 		 * }
 		 * ```
@@ -1106,7 +1106,7 @@ export interface AstroUserConfig {
 	 *
 	 * ```js
 	 * {
-	 *   server: { port: 1234, host: true}
+	 *   server: { port: 1234, host: true }
 	 * }
 	 * ```
 	 *
@@ -1340,7 +1340,7 @@ export interface AstroUserConfig {
 		 * @docs
 		 * @name image.domains
 		 * @type {string[]}
-		 * @default `{domains: []}`
+		 * @default `[]`
 		 * @version 2.10.10
 		 * @description
 		 * Defines a list of permitted image source domains for remote image optimization. No other remote images will be optimized by Astro.
@@ -1387,6 +1387,7 @@ export interface AstroUserConfig {
 		 * ```
 		 *
 		 * You can use wildcards to define the permitted `hostname` and `pathname` values as described below. Otherwise, only the exact values provided will be configured:
+	   *
 		 * `hostname`:
 		 *   - Start with '**.' to allow all subdomains ('endsWith').
 		 *   - Start with '*.' to allow only one level of subdomain.
@@ -1447,7 +1448,7 @@ export interface AstroUserConfig {
 		 * import remarkToc from 'remark-toc';
 		 * {
 		 *   markdown: {
-		 *     remarkPlugins: [ [remarkToc, { heading: "contents"} ] ]
+		 *     remarkPlugins: [ [remarkToc, { heading: "contents" }] ]
 		 *   }
 		 * }
 		 * ```
@@ -1517,7 +1518,7 @@ export interface AstroUserConfig {
 		 * {
 		 *   markdown: {
 		 *     // Example: Translate the footnotes text to another language, here are the default English values
-		 *     remarkRehype: { footnoteLabel: "Footnotes", footnoteBackLabel: "Back to reference 1"},
+		 *     remarkRehype: { footnoteLabel: "Footnotes", footnoteBackLabel: "Back to reference 1" },
 		 *   },
 		 * };
 		 * ```