pecan
pecan copied to clipboard
Add Script to Identify `Orphaned` Functions in Codebase
Description
This script identifies orphaned functions within our system. It iterates through modules, listing functions and checking if they are utilized within their module or externally. Unutilized functions are categorized as purely orphaned, while those used externally are noted separately. The results are output to a CSV file for further analysis.
Motivation and Context
The motivation behind this change is to clean up the codebase by identifying functions that are no longer in use. This can help in reducing the code size, improving maintainability, and potentially uncovering areas of the code that lack proper integration. It addresses the need for ongoing codebase optimization and cleanliness.
Review Time Estimate
- [ ] Immediately
- [X] Within one week
- [ ] When possible
Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
- [ ] My change requires a change to the documentation.
- [ ] My name is in the list of CITATION.cff
- [ ] I have updated the CHANGELOG.md.
- [ ] I have updated the documentation accordingly.
- [X] I have read the CONTRIBUTING document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.