Skip to content

update LALSimIMRPhenom(X) documentation with recent models

David Keitel requested to merge david-keitel/lalsuite:imrphenom-docs into master

Description

This adds the missing Pv3, Pv3HM, XPAS, XPHM entries, as reported in #287 (closed) , to the top-level IMRPhenom documentation and IMRPhenomXP family page.

@maria.haney please have a look. If you'd like additional review info added, you can add a commit directly to the branch, or post the exact info here and I can add it.

@karl-wette I have a doxygen question once again: Can I elegantly link from one page to one for another module without using the full URL, so that it's safe against future breakage? According to these docs I should be able to just write LALSimIMRPhenomX.c and have it auto-linked, but that doesn't seem to work.

PS: forgot to explicitly mention that I also modified the historical comments on A/B/C/D and P/Pv2. Didn't mean to slip that past anyone. I think it's safest (for the future) if these docs simply don't explicitly say which models are "most up-to date" and "should be used", but only which ones should definitely not be used anymore.

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

documentation change only

Edited by Ghost User

Merge request reports