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

[Refactor]: Rename AnalyzeManager to AnalysisManager #528

Open
RivanParmar opened this issue Jan 8, 2024 · 2 comments
Open

[Refactor]: Rename AnalyzeManager to AnalysisManager #528

RivanParmar opened this issue Jan 8, 2024 · 2 comments
Labels
enhancement Improvement for existing feature

Comments

@RivanParmar
Copy link

The name AnalyzeManager is quite confusing. Renaming it to AnalysisManager would make its purpose clearer, especially since the package name also has analysis in it. Other related files will also have to be renamed.

@itsaky
Copy link
Contributor

itsaky commented Jan 8, 2024

Renaming a class is probably not a good idea, especially when it is part of a library AND is a public API. This is because libraries are meant to be used in other projects, and if such a refactoring is done, it would unnecessarily introduce a breaking change and will require the implementations in dependant applications to be changed as well.

If that kind of refactoring is really needed, deprecating the current API and introducing a new API should be considered so other implementations have enough time to migrate to the new API. However, this might lead to significant changes in the library's codebase depending on how widely the current API is used internally in the library.

@RivanParmar
Copy link
Author

RivanParmar commented Jan 9, 2024

@itsaky You're right. Deprecating the current API would be a logical solution. Also, there are only about 16 to 17 usages in the library's codebase, which I think would be easy to replace right now rather than when the codebase expands.

I'm proposing this change since this library would be used in many projects and having a clear name would allow the developers to easily understand what the interface does as well as align with the naming conventions.

@Rosemoe Rosemoe added the enhancement Improvement for existing feature label Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement for existing feature
Projects
None yet
Development

No branches or pull requests

3 participants