Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #135: Remove dead comments and address edge treatment in 0-dimensional computation #183

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

agentmarketbot
Copy link

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

  1. Comment Removals:

    • Updated the comments in the 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.
  2. Code Maintenance:

    • Ensured that the codebase does not include misleading comments, thereby enhancing both maintainability and clarity for future development efforts.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dead comments in 0-dimensional computation/preferential treatment of edges with zero value
1 participant