doc: add version warning to embed_image()

jmcnamara · Feb 23, 2024 · 5ed3b90 · 5ed3b90
1 parent c3247af
commit 5ed3b90
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/dev/docs/source/worksheet.rst b/dev/docs/source/worksheet.rst
@@ -1430,8 +1430,9 @@ of the image is preserved but the size of the image is adjusted to fit the
 largest possible width or height depending on the cell dimensions.
 
 This is the equivalent of Excel's menu option to insert an image using the
-option to "Place in Cell". See :func:`insert_image` for the equivalent method to
-"Place over Cells".
+option to "Place in Cell" which is only available in Excel 365 versions from
+2023 onwards. For older versions of Excel a ``#VALUE!`` error is displayed. See
+:func:`insert_image` for the equivalent method to "Place over Cells".
 
 Here is an example::
 

diff --git a/examples/embedded_images.py b/examples/embedded_images.py
@@ -1,10 +1,14 @@
 ##############################################################################
 #
 # An example of embedding images into a worksheet cells using the XlsxWriter
-# Python module. This is equivalent to Excel's "Place in cell" image insert.
+# Python module.
 #
-# SPDX-License-Identifier: BSD-2-Clause
-# Copyright 2013-2024, John McNamara, [email protected]
+# This is the equivalent of Excel's menu option to insert an image using the
+# option to "Place in Cell" which is only available in Excel 365 versions from
+# 2023 onwards. For older versions of Excel a ``#VALUE!`` error is displayed.
+#
+# SPDX-License-Identifier: BSD-2-Clause Copyright 2013-2024, John McNamara,
+# [email protected]
 #
 import xlsxwriter