Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo in DetectorGeometry.DetectorPanel documentation #246

Open
godot11 opened this issue Sep 26, 2022 · 0 comments · May be fixed by #248
Open

Typo in DetectorGeometry.DetectorPanel documentation #246

godot11 opened this issue Sep 26, 2022 · 0 comments · May be fixed by #248

Comments

@godot11
Copy link

godot11 commented Sep 26, 2022

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}
@godot11 godot11 linked a pull request Sep 28, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant