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

Clean Up DrillManager.py codebase #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ALP2023
Copy link

@ALP2023 ALP2023 commented Dec 2, 2023

This issue is closed and now in review status - removed defunct code from DrillManager.py

Issue

Although the DrillManager.py document has detailed comments for functions and methods for the DrillManager Class, it contains a substantial amount of defunct commented-out code. This impacts the maintainability and readability of the codebase.

Why

  • Helps in understanding the current state of the code.
  • Reduces confusion.
  • Streamlines development process.
  • Reduces file size, even though commented-out code doesn’t execute, and helps in maintaining a more manageable codebase.
  • Unused code may contain vulnerabilities or security issues that were fixed in the active code.

Tasks

  • Review existing documentation for DrillManager.py.
  • Remove defunct/commented-out code.
  • Check no active code was erroneously deleted, i.e. check functionality in QGIS.

Copy link
Owner

@rolandhill rolandhill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi April,

The changes to DrillManager.py look fine to me. Be careful not to commit additional files, particularly those associated with your editor. There are several files in the .idea/ directory that I will ignore.

Cheers,
Roland

@rolandhill
Copy link
Owner

Actually, you might need to modify your PR and remove those .idea/ files first. My PR skills don't extend that far.

@ALP2023
Copy link
Author

ALP2023 commented Dec 6, 2023 via email

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.

2 participants