Skip to content
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

Update CCPP tech doc: schemes can currently have optional arguments in between regular arguments - follow up with moving opt args to the end #544

Open
climbfuji opened this issue Mar 8, 2024 · 1 comment
Labels
capgen bugs, requests, etc. that involve ccpp_capgen enhancement

Comments

@climbfuji
Copy link
Collaborator

Description

See discussion in #529 (comment).

Solution

For now, we keep the current non-standard approach that optional arguments can be anywhere in the call list, not just at the end (after the mandatory arguments). Since this is not standard, we must document this in the CCPP tech docs.

The long term solution depends on when/how the error handling changes. If for the foreseeable future we keep errmsg and errflg, we should move them to the beginning of the argument list and reorder the remaining arguments such that optional arguments come last. If the error handling is done differently in the future, the two arguments errmsg and errflg may no longer be necessary. Either way, we can re-arrange the argument list in a separate effort to follow the standard.

Alternatives (optional)

n/a

Related to (optional)

n/a

@mkavulich
Copy link
Collaborator

Details on optional arguments are included in NCAR/ccpp-doc#73, see the preview here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
capgen bugs, requests, etc. that involve ccpp_capgen enhancement
Projects
None yet
Development

No branches or pull requests

2 participants