Strengthen -Elines documentation for grdtrack and grdinterpolate #8108
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
These two functions both use the very rich -E option for creating profiles on the fly. The repetitive documentation for the two ahd some issues and missing modifiers, so this PR addes an explain_interpolant.rst_ file they can share. Also, the parsing of -F for the interpolant different between the two modules so I have introduced some function that both can call to avoid duplicate and errors in the code. Likewise, for teh documentation I added explain_interpolant.rst
PaulWessel
added
documentation
maxrjones
approved these changes
Nov 29, 2023
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.
This PR deals with two separate improvements:
explain_interpolant.rst_file.explain_interpolant.rst.Unfortunately, the docs for -E is not showing up in the HTML and I cannot see any difference between the include stuff for -E and -F, so I will need help to find probably an obvious issue, hence WIP.