Improve if statement readability and fix documentation typo #1133
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 new Feature/Bugfix
The pull request involves code modifications aimed at maintenance and readability improvements rather than introducing new features or fixing bugs. Specifically, I refactored the if statements to enhance code readability. Additionally, I corrected a typo in the documentation.
Related Issue: #
Unit-Tests for the new Feature/Bugfix
Compatibilities Issues
The changes made for code maintenance do not introduce any compatibility issues. Method signatures remain unchanged, and existing functionalities are not affected.
Testing details
To verify the code maintenance improvements, review the modified code and ensure that the if statements are now easier to understand and maintain. Confirm that the documentation typo has been corrected. Although no new functionality is introduced, it's advisable to run existing unit tests to ensure that the changes have not inadvertently caused any regressions. Additionally, consider performing manual testing to validate the modifications thoroughly.
Comment
This is my first attempt at contributing to an open-source project. It's also a project I've been using lately, and as I'm currently studying code that's easier to maintain, I've tried applying some of those principles to the codebase. I understand you must be busy, but I would greatly appreciate it if you could provide any feedback or suggestions on the changes I've made. Thank you.