-
Notifications
You must be signed in to change notification settings - Fork 70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Program option rendering / consistency issue #1278
Comments
Will fix next time a PR is pushed.
NONE is deprecated and will be removed (including from the documentation) at the end of the year anyway.
No. In this case, NONE means no prescription specified, so the default will be used. |
Thanks for addressing the issues. I think --pulsational-pair-instability-prescription is applicable only when --pulsational-pair-instability is TRUE. This is not specified in the program options. Furthermore, --pulsational-pair-instability is related to mass loss, so should it not be grouped under "Stellar evolution and winds" in the program options and under "Stellar properties" in the yaml file together with --pulsational-pair-instability-prescription in both places? In the description of --mass-transfer-fa, it can be mentioned that it's referring to the popular beta parameter. Also, the choice 'COMPAS' can be renamed to 'WOOSLEY' as there is no program option which mentions its default choice as 'COMPAS'. So the naming in this case is inconsistent with rest of the document. |
Added comment on pulsational-pair-instability-prescription being relevant only when pulsational-pair-instability is used. The only one I haven't done but I agree should probably be done is to change the name of the "COMPAS" PPISN prescription to WOOSLEY. @SimonStevenson , are you OK with that? |
@SimonStevenson -- please see my query in the message above. |
Must have missed this issue. Changes all sounds sensible to me, please go ahead! In general, I think we should think more about how to document the interdependency (if that's a word) between different program options. This is something that people often slip up on (change one option but not another related one). We can try to document this in the help and program options pages as best we can, but those strings also need to be kept short/readable. |
In the Program options page,
Under --OB-mass-loss and --OB-mass-loss-prescription, the default value is not specified in a new line although it was indended to be so.
Under --mass-loss-prescription, NONE is specified after ZERO. Elsewhere, the order is the opposite.
Under --critical-mass-ratio-prescription, option ZERO is not described. Is NONE going to be deprecated and replaced by ZERO?
The text was updated successfully, but these errors were encountered: