Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Deprecated symbols are switched in 2.18.0 release notes #10363

Closed
TacoTheDank opened this issue Jun 21, 2022 · 3 comments
Closed

[Docs] Deprecated symbols are switched in 2.18.0 release notes #10363

TacoTheDank opened this issue Jun 21, 2022 · 3 comments
Assignees
Labels

Comments

@TacoTheDank
Copy link

TacoTheDank commented Jun 21, 2022

As seen here: https://github.com/google/ExoPlayer/releases#:~:text=Remove%20Player.Listener.onTracksChanged.%20Use%20Player.Listener.onTracksInfoChanged%20instead

It currently says Remove Player.Listener.onTracksChanged. Use Player.Listener.onTracksInfoChanged instead.

It SHOULD say Remove Player.Listener.onTracksInfoChanged. Use Player.Listener.onTracksChanged instead.

I believe that this line is also wrong: As evident in the library, Player.getCurrentTracksInfo was renamed. It should not say "use this instead." I believe there are also other errors in this bullet, though I cannot say for sure.

These are just the ones I caught; however, I would suggest to have the entire 2.18.0 changelog reread in case there are also other mistakes that need fixing.

Thank you.

@TacoTheDank TacoTheDank changed the title [Documentation] Deprecated symbols are switched in 2.18.0 release notes [Docs] Deprecated symbols are switched in 2.18.0 release notes Jun 21, 2022
@icbaker icbaker self-assigned this Jun 21, 2022
@icbaker
Copy link
Collaborator

icbaker commented Jun 21, 2022

Hmmm, interesting.

Both those release notes were added in 25e58f5 (Feb 2022) and it matches the content of the commit (i.e. Player.Listener.onTracksChanged is removed, onTracksInfoChanged is preserved).

However we then made a follow-up commit (0ad508b) in April that renamed TracksInfo to Tracks and therefore, as collateral, renamed onTracksInfoChanged (back) to onTracksChanged. This is documented in separate release note bullet.

Both these commits were made after the 2.17.0 release, so they're both included in 2.18.0. Unfortunately we didn't merge the two release note bullets together, so the result is (as you've pointed out) slightly nonsensical.

Thanks for pointing this out! I think this is specific to this case where we removed and later re-added some symbols, rather than a systematic problem with the 2.18.0 release notes but I'll take a look for other issues too and make a change to fix things to make a bit more sense.

@TacoTheDank
Copy link
Author

I see, so it was slightly different from what I thought.

Thank you! I greatly appreciate it :)

marcbaechinger pushed a commit to androidx/media that referenced this issue Jul 4, 2022
rohitjoins pushed a commit that referenced this issue Jul 7, 2022
rohitjoins pushed a commit that referenced this issue Jul 15, 2022
Issue: #10363
PiperOrigin-RevId: 457679928
(cherry picked from commit 194043a)
rohitjoins pushed a commit to androidx/media that referenced this issue Jul 15, 2022
Issue: google/ExoPlayer#10363
PiperOrigin-RevId: 457679928
(cherry picked from commit a67db31)
@icbaker icbaker closed this as completed Aug 30, 2022
@TacoTheDank
Copy link
Author

Thanks!

@google google locked and limited conversation to collaborators Oct 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants