From 35ad11c8629e1e5ce526ce3932385888a1e2230e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89rico=20Nogueira?= Date: Wed, 27 May 2026 12:15:06 -0300 Subject: [PATCH] Document that NDFileTIFF implements readFile This happened in b3c7cdaa (Changes to implement readFile(); should be no effect on writeFile(), 2018-04-13), but the documentation wasn't updated. --- docs/ADCore/NDPluginFile.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/ADCore/NDPluginFile.rst b/docs/ADCore/NDPluginFile.rst index 612b22b4f..97b56525d 100644 --- a/docs/ADCore/NDPluginFile.rst +++ b/docs/ADCore/NDPluginFile.rst @@ -28,10 +28,10 @@ documentation <../areaDetectorDoxygenHTML/class_n_d_plugin_file.html>`__ describes this class in detail. This class is designed to simplify the task of supporting a new file format. A derived class to support a new file format will typically need to implement only the pure virtual -functions ``openFile()``, ``readFile()``, ``writeFile()``, and -``closeFile()``. Note that none of the current file plugins actually -support the ``readFile()`` function yet, but this is planned for future -releases. +functions ``openFile()``, ``readFile()``, ``writeFile()``, and +``closeFile()``. Note that out of the current file plugins, only +:doc:`NDFileTIFF` actually supports the ``readFile()`` function, though +further support is planned for future releases. The NDArray callback data can be written to disk in 1 of 3 modes: