Update docs and release notes

pydicom · Oct 26, 2022 · 7e09eac · 7e09eac
1 parent 80d8d3c
commit 7e09eac
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/doc/reference/elem.valuerep.rst b/doc/reference/elem.valuerep.rst
@@ -19,6 +19,7 @@ or TM and utilities.
    DSfloat
    DT
    IS
+   ISfloat
    MultiString
    PersonName
    PersonNameUnicode

diff --git a/doc/release_notes/v2.4.0.rst b/doc/release_notes/v2.4.0.rst
@@ -14,6 +14,8 @@ Enhancements
 * CLI commands now accept *pydicom* charset test files and CLI help shows
   Python Version (:pr:`1674`)
 * Added support for Python 3.11 (:issue:`1658`)
+* Added :class:`~pydicom.valuerep.ISfloat` to allow non-strict reading of
+  existing files with float IS values (:issue:`1661`)
 
 Fixes
 -----

diff --git a/pydicom/valuerep.py b/pydicom/valuerep.py
@@ -1257,6 +1257,11 @@ class ISfloat(float):
     Note: By the DICOM standard, IS can only be an :class:`int`,
     however, it is not uncommon to see float IS values.  This class
     is used if the config settings allow non-strict reading.
+
+    Generally, use :class:`~pydicom.valuerep.IS` to create IS values,
+    this is returned instead if the value cannot be represented as an
+    :class:`int`.  See :class:`~pydicom.valuerep.IS` for details of the
+    parameters and return values.
     """
     def __new__(  # type: ignore[misc]
             cls: Type["ISfloat"], val: Union[str, float, Decimal],