Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove avg dia + fix documentation #940

Merged
merged 2 commits into from
Nov 27, 2023
Merged

Remove avg dia + fix documentation #940

merged 2 commits into from
Nov 27, 2023

Conversation

blaisb
Copy link
Contributor

@blaisb blaisb commented Nov 27, 2023

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.

@blaisb
Remove avg dia + fix documentation
8cf7aa0 
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.
@OGaboriault
Copy link
Collaborator

You should add a comment in the Changelog about the removal of "average diameter" parameter in the prm files.

@blaisb
Copy link
Contributor Author

blaisb commented Nov 27, 2023

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
OGaboriault approved these changes Nov 27, 2023
View reviewed changes
Copy link
Collaborator

@OGaboriault OGaboriault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything's looking good.

@blaisb blaisb merged commit b0f02e7 into master Nov 27, 2023
13 checks passed
@blaisb blaisb deleted the standard_deviation_missing_from_documentation branch November 27, 2023 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OGaboriault OGaboriault OGaboriault approved these changes

Assignees
No one assigned
Labels
Reviewed and ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@blaisb @OGaboriault