Skip to content

clarify documentation of XLALCreateMultiSFTVector()

David Keitel requested to merge david-keitel/lalsuite:clarify-doc-XLALCreateMultiSFTVector into master

Description

@karl-wette XLALCreateMultiSFTVector() has a very confusing length argument which actually doesn't set the length of ther returned MultiSFTVector, but the number of bins in each single SFT. The MultiSFTVector length (number of IFOs) is actually determined from the length field of the second input (numsft).

Short of changing the function's API, this MR just clarifies explicitly in the documentation what's going on.

API Changes and Justification

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

Pure documentation fix.

Merge request reports