search

mpgirro / stalla

A Kotlin and Java library for RSS podcast feeds
https://stalla.dev
BSD 3-Clause "New" or "Revised" License
26 stars 5 forks source link

Deprecate PodcastBuilder.podcastPodcastindexBuilder property #89

Closed mpgirro closed 3 years ago

mpgirro commented 3 years ago

The PodcastBuilder interface exposes a property by the name podcastPodcastindexBuilder. To be consistent in our naming schema, this property should simply be called podcastindexBuilder.

This is an API-breaking change and should be implemented in a yet unplanned release when breaking changes will be allowed.

rock3r commented 3 years ago

We should have a deprecation window for the property; doing a rename in 1.x (maybe even 1.1), with an appropriate ReplaceWith in place. Schedule it for deletion in 2.0, mark it as such in the deprecation notice, and then go along until 2.0 is here.

rock3r commented 3 years ago

We can also use org.jetbrains.annotations.ApiStatus.ScheduledForRemoval(inVersion = "2.0.0") to explicitly mark the version when we're dropping it

mpgirro commented 3 years ago

Looks like @ScheduledForRemoval isn't applicable in this case. We need to annotate the interface member, and the annotation requires a backing field or delegate (Kotlin supports neither in interfaces).

rock3r commented 3 years ago

Ah, dang it. Well, was worth a try :)

rock3r commented 3 years ago

Looks like this was done in #93