Improved comment on fK and meson mixing

MJKirk commented 2 years ago

Added a comment to the parameter file to summarise my discussion with David in #171
Add a note that the meson mixing matrix element values have the 1/2M normalisation included - this is something I periodically forget in flavio, and spend a while wondering why the code is M * f^2 * bag not M^2 * f^2 * bag before remembering. I wasn't sure whether to just add a comment in the code or alter the docstring - I decided on the docstring since someone (possibly future me again) might look there first after being confused about the values that matrixelements returns before looking at the source code.

coveralls commented 2 years ago

Coverage decreased (-0.01%) to 93.879% when pulling 16c47d3c70395e3d056ae29a1460b5ec36b1a904 on MJKirk:fK-mesonmixing-comments into 3b8032913b79d01a48190ca7ab3366ff67b70173 on flav-io:master.

coveralls commented 2 years ago

Coverage decreased (-0.01%) to 93.879% when pulling 16c47d3c70395e3d056ae29a1460b5ec36b1a904 on MJKirk:fK-mesonmixing-comments into 3b8032913b79d01a48190ca7ab3366ff67b70173 on flav-io:master.

peterstangl commented 2 years ago

Thanks @MJKirk! I think it makes sense to have the comment in the docstring.

flav-io / flavio

Improved comment on fK and meson mixing #173