GithubHelp home page GithubHelp logo

Comments (2)

itsaky avatar itsaky commented on July 24, 2024 1

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.

from sora-editor.

RivanParmar avatar RivanParmar commented on July 24, 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.

from sora-editor.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.