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

Correct dataTypeIndex ambiguous definition #152

Merged
merged 3 commits into from
Jul 23, 2024
Merged

Conversation

HanBnrd
Copy link
Member

@HanBnrd HanBnrd commented Jul 22, 2024

Fixes #87

Corrects the dataTypeIndex ambiguous definition to clarify that it is indeed an integer (and not a numeric 1-D array).

Elements that have also been checked for coherence with this PR:

  • dataType
  • dataTypeLabel
  • detectorModuleIndex
  • probe/wavelengths
  • probe/frequencies
  • probe/timeDelays
  • probe/timeDelayWidths
  • probe/momentOrders
  • probe/correlationTimeDelays
  • probe/correlationTimeDelayWidths
  • Appendix

@HanBnrd HanBnrd marked this pull request as ready for review July 22, 2024 09:05
Copy link
Collaborator

@samuelpowell samuelpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than say

Note that the Time Domain and Diffuse Correlation Spectroscopy data types have two additional parameters and so the data type index is used to map both those additional parameters with the same index.

Why not

Note that where multiple parameters are required the same index must be used into each (examples include data types such as Time Domain and Diffuse Correlation Spectroscopy).

The latter is more general and reduces coupling.

@dboas
Copy link
Collaborator

dboas commented Jul 22, 2024

@samuelpowell this has two approvals. Do you want to merge it?

@samuelpowell samuelpowell merged commit 4488803 into master Jul 23, 2024
4 checks passed
@samuelpowell samuelpowell deleted the datatypeindex branch July 23, 2024 07:55
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 this pull request may close these issues.

dataTypeIndex is defined ambiguously
3 participants