Random improvements #92
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 function "generateChemicalFormula()" that was previously a method of the Model class was rewritten. It is now slightly shorter and no longer part of Model. These changes aim to improve readability. Previously the function took no arguments, so the input and output was obscured. With this change, the function has a return value and input arguments. Hence, when the function is called in generateVolumeData(), it is clear where the output is stored. The scope of the function has also been limited, because it was only called once. Therefore, it is not necessary to have the function be available to the entire Model class. The function declaration has been placed before the definition of generateVolumeData().
Changes have been made to the chain of functions that were called in order to begin the type assignment algorithm. Previously, there was a long chain of functions that were called in sequence. runCalculation() calls generateData() calls generateVolumeData() calls calcVolume(), and only then is the function called that begins the type assignment. This is somewhat confusing. The contents of calcVolume() have been moved to generateVolumeData(). The part of generateVolumeData() that was tasked with making preparations for the calculation has been placed in a separate function.
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.
Adds minor improvements to the code. Some light restructuring for clarity.