Documentation for Fragment#setRetainInstance(boolean) is incorrect [37069045]

Fixed

Bug

Status Update

No update yet.

Description

gr...@gmail.com

created issue #1

Nov 1, 2015 05:43AM

http://developer.android.com/reference/android/app/Fragment.html#setRetainInstance(boolean)

The part in the linked documentation where it says "This can only be used with fragments not in the back stack" looks like a it is based on legacy limitations.

I have tested it, and it works perfectly fine with addToBackStack(). According to

https://www.reddit.com/r/androiddev/comments/34fb2m/retaininstancetrue_behavior_changed_in/, it has worked since v20.0.0 of the support lib.

I think a lot of people are mislead by this particular piece of documentation, can it be removed?

Comments

gr...@gmail.com <gr...@gmail.com> #2Nov 1, 2015 05:46AM

I linked the framework Fragment documentation, but the support Fragment documentation is the same:

http://developer.android.com/reference/android/support/v4/app/Fragment.html#setRetainInstance(boolean)

au...@google.com <au...@google.com> Jun 8, 2016 07:35PM

Assigned to ad...@android.com.

il...@google.com <il...@google.com> Nov 30, 2018 01:13AM

Reassigned to il...@google.com.

il...@google.com <il...@google.com> Nov 30, 2018 05:00AM

Accepted by il...@google.com.

ap...@google.com <ap...@google.com> #3Nov 30, 2018 10:10PM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit d933bd113831acf7ffaccb303a0b1e24461e3a63
Author: Ian Lake <ilake@google.com>
Date: Thu Nov 29 20:56:52 2018

Correct setRetainInstance() docs

Remove comment about retained Fragments
not being supported on the back stack since
that is indeed supported and has been
for some time.

Test: n/a
BUG: 37069045
Change-Id: Ic3c095c2678b25eac6b561d0145f89c69e18be46

M fragment/src/main/java/androidx/fragment/app/Fragment.java

https://android-review.googlesource.com/837642

https://goto.google.com/android-sha1/d933bd113831acf7ffaccb303a0b1e24461e3a63

il...@google.com <il...@google.com> #4Nov 30, 2018 10:11PM

Marked as fixed.

Took a few years, but this has been fixed for AndroidX Fragments. (Framework fragments are deprecated and Support Library Fragments have been completely replaced with AndroidX Fragments)

Issue 37069045