Skip to content

Improve documentation and argument checking for lalpulsar_MakeSFTs

Evan Goetz requested to merge evan-goetz/lalsuite:update-docs-makesfts into master

Description

This MR improves documentation of input arguments for lalpulsar_MakeSFTs so users know how to make both "public" and "private" SFT files (different file naming conventions). In addition this MR also improves input argument tests to avoid segmentation faults when testing string comparisons and limitations of the program.

Closes #763 (closed)

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

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

@karl-wette should review these changes

Merge request reports