Remove in-depth documentation for AuthUI.java and link to README instead #569
Conversation
Signed-off-by: Alex Saveau <[email protected]>
| * </li> | ||
| * <p> | ||
| * </ul> | ||
| * See the <a href="https://github.com/firebase/FirebaseUI-Android/tree/master/auth#using-firebaseui-for-authentication">README</a> |
There was a problem hiding this comment.
Let's just link to the README itself rather than a section since those headers could change:
https://github.com/firebase/FirebaseUI-Android/blob/master/auth/README.md
There was a problem hiding this comment.
@samtstern I changed the link to reference the file directly, and changed the url fragment to reference the Table of Contents (something that shouldn't change anytime soon). If we do change it and forget to update the docs, it'll just go to the top of the page anyway.
|
I think this is a good change since you're right, we never update this JavaDoc. It's unfortunate but it's better to have an up-to-date link than broken docs! |
Signed-off-by: Alex Saveau <[email protected]>
| @@ -304,8 +144,8 @@ public static AuthUI getInstance(FirebaseApp app) { | |||
| } | |||
|
|
|||
| /** | |||
| * Default theme used by {@link SignInIntentBuilder#setTheme(int)} if no theme | |||
| * customization is required. | |||
| * Default theme used by {@link SignInIntentBuilder#setTheme(int)} if no theme customization is | |||
There was a problem hiding this comment.
Just a note for the future, including formatting changes like this that are unrelated to the functionality of the PR is distracting. I can normally look around it, but just wanted to point it out.
Is it your IDE settings that do this automatically?
There was a problem hiding this comment.
@samtstern Yeah, sorry. Intellij, just does that automatically when formatting stuff. (I should poke around and try to find where the setting is to disable it, but I've been lazy. I'll look into it at some point.)
@samtstern This change is up to debate, but I've noticed that we rarely update the
AuthUI.javadocumentation and I feel like it would make it easier for us to directly link users to the README giving them the most up to date documentation and promoting awareness of our sub-READMEs.@samtstern What do you think? The only con I can think of is that devs on an airplane without wifi might not be happy. 😄