Add documentation note to readComponent

lsst · Jan 19, 2021 · 53cd70a · 53cd70a
1 parent 9a35beb
commit 53cd70a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/image/ExposureFitsReader.cc b/src/image/ExposureFitsReader.cc
@@ -401,6 +401,10 @@ class ExposureFitsReader::ArchiveReader {
      *
      * @throws pex::exceptions::NotFoundError Thrown if the component is
      *     registered in the file metadata but could not be found.
+     *
+     * @note When accessing via %pybind11, components with derived subclasses, such
+     *       as ``TransmissionCurve``, are not properly type converted and thus
+     *       the specialized reader must be used instead of ``readComponent``.
      */
     // This method takes a string instead of a strongly typed Key because
     // readExtraComponents() gets its keys from the FITS metadata.