Remove avg dia + fix documentation #940
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
The average diameter parameter does not really add anything to the parameter file. So it has now been removed. Documentation has been cleared to specify the standard deviation.
|
You should add a comment in the Changelog about the removal of "average diameter" parameter in the prm files. |
Absolutely. You are absolutely right. This has been changed |
OGaboriault
approved these changes
Nov 27, 2023
M-Badri
pushed a commit
to M-Badri/lethe
that referenced
this pull request
Sep 29, 2024
Description of the problem The standard deviation parameter was not clearly defined in the documentation We had an average diameter and diameter parameter. This is confusing for no reason. Description of the solution Clear our the documentation and remove the average diameter parameter. It does not impact anything on the data structures anyway so yay! How Has This Been Tested? All unit tests passed on my machine. Documentation Changed documentation on the particle type themselves. Former-commit-id: b0f02e7
blaisb
added a commit
that referenced
this pull request
Sep 30, 2024
Description of the problem The standard deviation parameter was not clearly defined in the documentation We had an average diameter and diameter parameter. This is confusing for no reason. Description of the solution Clear our the documentation and remove the average diameter parameter. It does not impact anything on the data structures anyway so yay! How Has This Been Tested? All unit tests passed on my machine. Documentation Changed documentation on the particle type themselves. Former-commit-id: b0f02e7
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.
Description of the problem
Description of the solution
How Has This Been Tested?
Documentation