Giter VIP home page Giter VIP logo

Comments (3)

Gerrit0 avatar Gerrit0 commented on September 28, 2024 1

I'm certainly not ruling out a 1.0 sometime in the future, but I really need to figure out how to decide on what is public, and go through the 500+ "public-ish" things and properly mark them all first... not a very high priority to me.

from typedoc.

Gerrit0 avatar Gerrit0 commented on September 28, 2024

Yes, it's been considered. 5 years ago I thought I'd be making a 1.0 release in a couple of months. That obviously hasn't happened.

In practice, while pieces of TypeDoc, mainly the CLI interface with common options, and to a lesser extent the JS API, are very stable, other pieces are not... and what the "public API" is isn't well defined.

If TypeDoc didn't support plugins, some of which reach deep into what probably should be considered internals, but is effectively public, it'd have been 1.0 ages ago (and probably 3.0 today), if I'd gone to 1.0 back then, we'd be at least at 25.x today when considering plugins.

Currently what is done is that changes I know will be breaking wait for 0.x.0 releases, while changes which likely won't affect anyone (at least those only using public plugins, or no plugins) can be included in any release. I've been wary of going to 1.x as in my mind it promises more stability than I can guarantee with every piece of TypeDoc being effectively public.

from typedoc.

ben-polinsky avatar ben-polinsky commented on September 28, 2024

Sure, I can understand that. But it does seem like people are using this in production and relying on the library's public APIs. Fair enough, just wanted to know if you had thought of it. Thanks.

from typedoc.

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.