Add developer documentation for run(3f) and example program #933
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
perazz
approved these changes
Jun 10, 2023
There was a problem hiding this comment.
Thank you @urbanjost for this update, good to see better developer documentation!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Direct use of execute_command_line(3f) is appearing frequently in the code. Early in the design there was an intent that all external system calls be treated in a similiar manner by going through a wrapper routine. That wrapper routine was lacking documentation and, having grown organically it is not quiet intuitive. So this PR is nothing but documenation changes for the ford(1)=generated developer documentation. It includes a few minor corrections of other documentation but is primarily just documentation for the run(3f) procedure. It should cause no function changes, being just comments.