Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo in code comments #11944

Merged
merged 2 commits into from
Sep 25, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ export interface AstroUserConfig {
/**
* @docs
* @name security
* @type {boolean}
* @type {object}
* @default `{}`
* @version 4.9.0
* @description
Expand All @@ -838,7 +838,7 @@ export interface AstroUserConfig {
* @name security.checkOrigin
* @kind h4
* @type {boolean}
* @default 'false'
* @default `false`
* @version 4.9.0
* @description
*
Expand Down Expand Up @@ -1088,7 +1088,7 @@ export interface AstroUserConfig {
* ```js
* {
* build: {
* inlineStylesheets: `never`,
* inlineStylesheets: 'never',
* },
* }
* ```
Expand All @@ -1106,7 +1106,7 @@ export interface AstroUserConfig {
*
* ```js
* {
* server: { port: 1234, host: true}
* server: { port: 1234, host: true }
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: add missing whitespace

* }
* ```
*
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -1447,7 +1448,7 @@ export interface AstroUserConfig {
* import remarkToc from 'remark-toc';
* {
* markdown: {
* remarkPlugins: [ [remarkToc, { heading: "contents"} ] ]
* remarkPlugins: [ [remarkToc, { heading: "contents" }] ]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: add missing whitespace

* }
* }
* ```
Expand Down Expand Up @@ -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" },
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE: add missing whitespace

* },
* };
* ```
Expand Down
Loading