Added some more comments to volume.py in maths folder #7080
Conversation
This file contains hidden or 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
added some more comments (to formulas which need it) which make the code more readable and understandable. might make a list of all the formulas on the top, later
algorithms-keeper
bot
added
enhancement
for more information, see https://pre-commit.ci
14 tasks
cclauss
requested changes
Oct 13, 2022
There was a problem hiding this comment.
I have moved the comments down to be just above the calculations. I have changed the order of the terms to be the same in both the comments and the calculations. I have changed Volume - to Volume is because - has a special meaning in calculations. ;-)
Please fix the line that is failing our tests because it has more than 88 characters.
maths/volume.py
Outdated
Comment on lines
291
to
294
| # Volume - 4/3 * pi * radius cubed | ||
| if radius < 0: | ||
| raise ValueError("vol_hemisphere() only accepts non-negative values") | ||
| return 2 / 3 * pi * pow(radius, 3) |
There was a problem hiding this comment.
Suggested change
| # Volume - 4/3 * pi * radius cubed | |
| if radius < 0: | |
| raise ValueError("vol_hemisphere() only accepts non-negative values") | |
| return 2 / 3 * pi * pow(radius, 3) | |
| if radius < 0: | |
| raise ValueError("vol_hemisphere() only accepts non-negative values") | |
| # Volume is radius cubed * pi * 2/3 | |
| return pow(radius, 3) * pi * 2 / 3 |
maths/volume.py
Outdated
Comment on lines
318
to
321
| # Volume - radius squared * height * pi | ||
| if height < 0 or radius < 0: | ||
| raise ValueError("vol_circular_cylinder() only accepts non-negative values") | ||
| return pi * pow(radius, 2) * height |
There was a problem hiding this comment.
Suggested change
| # Volume - radius squared * height * pi | |
| if height < 0 or radius < 0: | |
| raise ValueError("vol_circular_cylinder() only accepts non-negative values") | |
| return pi * pow(radius, 2) * height | |
| if height < 0 or radius < 0: | |
| raise ValueError("vol_circular_cylinder() only accepts non-negative values") | |
| # Volume is radius squared * height * pi | |
| return pow(radius, 2) * height * pi |
maths/volume.py
Outdated
| @@ -378,6 +385,7 @@ def vol_conical_frustum(height: float, radius_1: float, radius_2: float) -> floa | |||
| ... | |||
| ValueError: vol_conical_frustum() only accepts non-negative values | |||
| """ | |||
| # Volume - 1/3 * pi * height * (radius_1 squared + radius_2 squared + radius_1 * radius_2) | |||
There was a problem hiding this comment.
Tests are failing on:
- maths/volume.py:388:89: E501 line too long (94 > 88 characters)
Also, please move this line down to be just above the calculation. Make sure that the order of the values in the comment and in the calculation are the same.
algorithms-keeper
bot
added
awaiting changes
algorithms-keeper
bot
added
awaiting reviews
cclauss
reviewed
Oct 13, 2022
cclauss
added
hacktoberfest
hacktoberfest-accepted
cclauss
reviewed
Oct 13, 2022
for more information, see https://pre-commit.ci
Aadi077
suggested changes
Oct 13, 2022
|
how do i commit your changes? |
for more information, see https://pre-commit.ci
algorithms-keeper
bot
removed
the
tests are failing
|
Hello Sir, Can you assign this to me? |
cclauss
approved these changes
Oct 16, 2022
algorithms-keeper
bot
removed
the
awaiting reviews
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.
added some more comments (to formulas which need it) which make the code more readable and understandable. might make a list of all the formulas on the top, later
Checklist:
Fixes: #{$ISSUE_NO}.