From f9ab828e2992f795b57fe03ad10d498b315f7e7d Mon Sep 17 00:00:00 2001
From: Laurenz Stampfl <47084093+LaurenzV@users.noreply.github.com>
Date: Fri, 19 May 2023 14:41:33 +0200
Subject: [PATCH] Add note about embedding svg images (#1243)

---
 library/src/visualize/image.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/library/src/visualize/image.rs b/library/src/visualize/image.rs
index 071aab214..c38f5e782 100644
--- a/library/src/visualize/image.rs
+++ b/library/src/visualize/image.rs
@@ -11,6 +11,10 @@ use crate::text::families;
 ///
 /// Supported formats are PNG, JPEG, GIF and SVG.
 ///
+/// _Note:_ Work on SVG export is ongoing and there might be visual inaccuracies
+/// in the resulting PDF. Make sure to double-check embedded SVG images. If you
+/// have an issue, also feel free to report it on [GitHub][gh-svg].
+///
 /// ## Example { #example }
 /// ```example
 /// #figure(
@@ -22,6 +26,8 @@ use crate::text::families;
 /// )
 /// ```
 ///
+/// [gh-svg]: https://github.com/typst/typst/issues?q=is%3Aopen+is%3Aissue+label%3Asvg
+///
 /// Display: Image
 /// Category: visualize
 #[element(Layout, LocalName, Figurable)]