Skip to content

Better document SFT file input/pattern options for LALPulsar codes

Karl Wetterequested to merge
(removed):doc-SFT-file-pattern into master

Description

Documentation string taken from Weave.c:

Possibilities are:
 - '<SFT file>;<SFT file>;...', where <SFT file> may contain wildcards
 - 'list:<file containing list of SFT files>'

I did a search for usage of XLALSFTdataFind(), looked at what variable was being passed in, and then found its documentation. This way I've hopefully found all the codes that need an SFT file input/pattern.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

Review Status

cc @david-keitel @evan-goetz for approval

Merge request reports