fix:Fit perimeter.cpp to guidelines #2911
Open
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
fix: corrected perimeter implementation and updated documentation ### Description of Change - Fixed parameter names for triangle and parallelogram perimeter functions to reflect correct usage of sides instead of base/height. - Removed cube and cylinder perimeter functions, as perimeter is defined only to 2D shapes. - Renamed `n_polygon_surface_perimeter` to `n_sides_regular_polygon_perimeter` for improved clarity. - Updated and clarified documentation for all perimeter-related functions to follow Doxygen guidelines. - Added tests to ensure correctness of all perimeter calculations. ### Checklist - [x] Added description of change - [x] Added tests and example, test must pass - [x] Added documentation so that the program is self-explanatory and educational - Doxygen guidelines - [x] Relevant documentation/comments are changed or added - [x] PR title follows semantic commit guidelines - [x] Searched previous suggestions to avoid duplication - [x] I acknowledge that all my contributions will be made under the project's license ### this is my first contribution here :-)
fix:Fit perimeter.cpp to guidelines
Ryn9785
requested review from
Panquesito7 and
realstealthninja
as code owners
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.
fix: corrected perimeter implementation and updated documentation
Description of Change
n_polygon_surface_perimeterton_sides_regular_polygon_perimeterfor improved clarity.Checklist
note:
this is my first contribution here :-)