From a281e2f7db1b57912c996c2708ce132f1a566ebb Mon Sep 17 00:00:00 2001
From: Brendt Wohlberg <brendt@ieee.org>
Date: Thu, 26 Oct 2023 16:21:00 -0600
Subject: [PATCH] Add warning to api docs

---
 scico/linop/xray/_xray.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/scico/linop/xray/_xray.py b/scico/linop/xray/_xray.py
index 5ae6ea179..c0465b236 100644
--- a/scico/linop/xray/_xray.py
+++ b/scico/linop/xray/_xray.py
@@ -26,6 +26,10 @@ class XRayTransform(LinearOperator):
     """X-ray transform operator.
 
     Wrap an X-ray projector object in a SCICO :class:`LinearOperator`.
+    **Warning:**  Note that the only X-ray projector object currently
+    supported, :class:`.Parallel2dProjector`, is not a very accurate
+    approximation of the integral transform representing real projection
+    imaging, and is therefore not suitable for real imaging applications.
     """
 
     def __init__(self, projector):