From 325f1ca27d5b7eb6236c9ad659e8c87986b63c94 Mon Sep 17 00:00:00 2001 From: Lonami Exo Date: Thu, 12 Oct 2023 20:46:57 +0200 Subject: [PATCH] Update changelog --- client/doc/developing/changelog.rst | 59 +++++++++++++++++++++-- client/doc/developing/migration-guide.rst | 2 +- 2 files changed, 57 insertions(+), 4 deletions(-) diff --git a/client/doc/developing/changelog.rst b/client/doc/developing/changelog.rst index 52869da3..5a42de26 100644 --- a/client/doc/developing/changelog.rst +++ b/client/doc/developing/changelog.rst @@ -1,8 +1,61 @@ Changelog (Version History) =========================== +v2.0-alpha.0 +------------ -v2 alpha --------- ++------------------------+ +| Scheme layer used: 165 | ++------------------------+ -WIP! +`View new and changed raw API methods `__. + +.. important:: + + **The first alpha of Telethon v2 is here!** + +What a ride! + +This has been a long-time coming and I am so glad I don't need to work on the old and messy code-base anymore! + +This changelog will no longer have catchy names for the different versions. +It's been a while since I was able to come up with meaningful names, anyway. + +Instead of breaking down what's new, changed, or removed from this version, there is a migration guide. +Be warned, it's a lot! +But in short, this is mostly a "reset" to cut down on the bloat of the library. +The library should still result familiar. + +.. seealso:: + + :doc:`migration-guide` + +Your v1 code likely won't be compatible with v2. +However, a lot of effort has gone into making v2 type-safe. +This means you can use static type-checkers to be confident you're using the new methods correctly. + +A lot of work has been put into ensuring the documentation is the best it can be. +If you find any errata or confusing sections, please `open a Documentation Issue `_. + +.. rubric:: What happens to Telethon v1 now? + +Version 1 will probably be maintained for a while longer. + +New layers will be released, and bugs that make it unusable fixed. +As long as I have the time to do so. +This will not be a priority. +There is no specific end-of-life date, but it will not last forever. + +No new features will be added to v1, or smaller bugs fixed. +This should not be news to anyone, as it has already been the case for a while now. + +You can keep using v1 for now. +But a lot of work has been put into v2 and its migration guide. +I hope you can take this opportunity to migrate and dust off some of your old code! + +v1.x and below +-------------- + +The old `v1 changelog `_ is still available online. +And in the history of the repository. +It has been removed from the current documentation to keep it lighter. diff --git a/client/doc/developing/migration-guide.rst b/client/doc/developing/migration-guide.rst index 557cd6a5..440f3608 100644 --- a/client/doc/developing/migration-guide.rst +++ b/client/doc/developing/migration-guide.rst @@ -82,7 +82,7 @@ You can no longer ``import telethon.sync`` to have most calls wrapped in :meth:` Raw API is now private ---------------------- -v2 aims to comply with `Semantic Versioning `. +v2 aims to comply with `Semantic Versioning `_. This is impossible because Telegram is a live service that can change things any time. But we can get pretty close.