#3035 Remove deprecated rename_channel
Closed: Fixed 2 years ago by tkopecek. Opened 2 years ago by tkopecek.

%SUBJ%


The rename-channel command was marked deprecated in PR#2905.

Neither of the two issues listed for that PR appears to specifically call for a deprecation of this longstanding command (added in 2010).

I don't know if we've had sufficient discussion here, and I'm not sure I'm convinced we should actually do this.

Metadata Update from @mikem:
- Custom field Size adjusted to None

2 years ago

The main reason was it is now superceded by edit-channel. We can theoretically leave it alive for compatibility reasons.

My general opinion is that we should maintain backwards compatibility in the hub api (and to a lesser extent in the cli) unless we have a very strong reason. In this case, the call unification seems to be an aesthetic choice unrelated to the driving feature. I don't think this is a strong reason to introduce an incompatibility.

My recommendations are:

  • for the hub call, preserve rename_channel with the same signature, but update the docstring to indicate that editChannel is now preferred. We should be able make the call a very simple wrapper around edit_channel. Looks like just edit_channel(old, name=new). So we still get rid of some code.

  • for the cli, I'm somewhat less concerned, but with our faster release cadence I'm not sure that two releases (~6 months) is enough warning. This deprecation landed in 1.26 (Aug 2021). If we're going to remove it, I'd prefer more runway at least.

Metadata Update from @jcupova:
- Issue tagged with: testing-ready

2 years ago

Metadata Update from @ksulayma:
- Issue tagged with: testing-done

2 years ago

Login to comment on this ticket.

Metadata
Related Pull Requests
  • #3108 Merged 2 years ago