From 2a14a898f59832f3a2fa71f3b90d6eb7d5a9ff93 Mon Sep 17 00:00:00 2001
From: Ben Schlegel <ben5.schlegel@gmail.com>
Date: Fri, 26 Jan 2024 20:41:06 +0100
Subject: [PATCH] chore: improve comments + types

---
 quartz/cfg.ts               | 2 +-
 quartz/components/Head.tsx  | 2 +-
 quartz/util/socialImage.tsx | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/quartz/cfg.ts b/quartz/cfg.ts
index 4d1ac664d..0175d5a1b 100644
--- a/quartz/cfg.ts
+++ b/quartz/cfg.ts
@@ -35,7 +35,7 @@ export interface GlobalConfiguration {
    */
   baseUrl?: string
   /**
-   * Wether to generate and use social images (Open Graph and Twitter standard) for link previews
+   * Wether to generate social images (Open Graph and Twitter standard) for link previews
    */
   generateSocialImages: boolean | Partial<SocialImageOptions>
   theme: Theme
diff --git a/quartz/components/Head.tsx b/quartz/components/Head.tsx
index e30cb1f2f..c1f0bd8ff 100644
--- a/quartz/components/Head.tsx
+++ b/quartz/components/Head.tsx
@@ -10,7 +10,7 @@ import { JSXInternal } from "preact/src/jsx"
 import { unescapeHTML } from "../util/escape"
 
 /**
- * Generates social image (OG/twitter standard) and saves it as `.web` inside the public folder
+ * Generates social image (OG/twitter standard) and saves it as `.webp` inside the public folder
  * @param opts options for generating image
  */
 async function generateSocialImage(opts: ImageOptions, userOpts: SocialImageOptions) {
diff --git a/quartz/util/socialImage.tsx b/quartz/util/socialImage.tsx
index ec65b5943..01ad5666a 100644
--- a/quartz/util/socialImage.tsx
+++ b/quartz/util/socialImage.tsx
@@ -2,7 +2,7 @@ import { SatoriOptions } from "satori/wasm"
 import { GlobalConfiguration } from "../cfg"
 import { SocialImageOptions } from "./imageHelper"
 
-export const defaultImage = (
+export const defaultImage: SocialImageOptions["imageStructure"] = (
   cfg: GlobalConfiguration,
   userOpts: SocialImageOptions,
   title: string,