scr: update docs to document return value in Fortran failure case #291
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request does two things:
SCR_Config
docs explaining how Fortran reports that a parameter was not found (sets ierr to 1)the second may be something to discuss though there is already code in eg
scr_route_file
that does returnSCR_FAIULRE
and not eg!SCR_SUCCESS
so the value is already used (even thoughSCR_FAILURE == !SCR_SUCCESS
anyway).