Add documentation for various parts of software #195
Merged
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
|
This should be ready to go now! One small suggestion I have is for the title "Mathematical implementation" -- it is weird to have the word "implementation" in this, since there is the algorithmic implementation. I suggest changing this to just "Theory" or "Underlying theory", since it includes both acoustics and geostatistics theories. |
This was referenced Mar 7, 2024
Closed
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.
information and mathematical equations
glossary.mdwas added to contain a list of symbols and variable namesthat can be found throughout the workflow of the software both programmatically and in the mathematical equations