Fixes #135: Remove dead comments and address edge treatment in 0-dimensional computation #183
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.
Pull Request Description
Overview
This pull request addresses the issue of outdated comments and preferential treatment of edges with zero value in the 0-dimensional computation of the
ripser/ripser.cpp
file, as highlighted in Issue #135. The changes made aim to improve code clarity and ensure that comments accurately reflect the current implementation.Background
The issue was raised due to the presence of dead comments that do not convey the intended functionality, particularly concerning the way edges with zero value are handled in 0-dimensional computations. These comments may lead to confusion for future contributors and users of the code. A related discussion can be found in GitHub Issue #31.
Changes Made
Comment Removals:
ripser/ripser.cpp
file, specifically around line 687, to remove or revise outdated commentary that may mislead users regarding the handling of 0-dimensional computations.Code Maintenance:
Impact
These changes contribute to the overall clarity of the project, making it easier for current and future developers to understand the code logic related to 0-dimensional computations. The removal of outdated comments aligns with our commitment to maintaining high-quality documentation companioning the code.
Conclusion
This pull request aims to improve the clarity and maintainability of the
ripser.py
codebase by removing outdated comments concerning 0-dimensional computations.Closing Remarks
By merging this pull request, we will resolve Issue #135.
Fixes #135.
Please review the changes, and let's enhance the project's code quality together!