PaNOSC-ViNYL / SimEx

Start-to-end photon experiment simulation platform
https://simex.readthedocs.io/
GNU General Public License v3.0
26 stars 25 forks source link

Typo in DetectorGeometry.DetectorPanel documentation #246

Open godot11 opened 1 year ago

godot11 commented 1 year ago

There is a typo in the documentation of Parameters.DetectorGeometry.DetectorPanel.__init__ in the entry of ranges:

        :param ranges: The minimum and maximum values pixel numbers on the respective transverse axis.
        :type  ranges: Dictionary
        :example ranges: {"fast_scan_min : 11, "fast_scan_max" : 20, "slow_scan_min" : 1, "fast_scan_max" : 20} # First axis from 11 to 20 and second axis from 1 to 20.

I assume the 4th key in the example dictionary should be slow_scan_max, not fast_scan_max:

{"fast_scan_min : 11, "fast_scan_max" : 20, "slow_scan_min" : 1, "slow_scan_max" : 20}