android / android/android-test

Better docs for UriIdlingResource

Open
#677 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
1.2k
Forks
342
Avg merge
11h 29m
Merged PRs (30d)
2

Description

### Description
I came across a usecase where I wanted to use UriIdlingResource in some WebView [tests](https://android-review.googlesource.com/c/platform/frameworks/support/+/1348702) which were flaky. The class description needs to be updated as it has a line that says it's still in beta which isn't true any more, I can see it has been part of multiple stable releases. I also think the class docs would benefit from having a sample code that demonstrates its typical use.

### AndroidX Test and Android OS Versions
the latest 3.3.0-rc01

### Link to a public git repo demonstrating the problem:
https://github.com/android/android-test/blob/master/espresso/idling_resource/net/java/androidx/test/espresso/idling/net/UriIdlingResource.java

Contributor guide

Open the contributing guide

Research direction

Open espresso/idling_resource/net/java/androidx/test/espresso/idling/net/UriIdlingResource.java and review the class description. Remove the outdated beta wording and add a concise typical-use example, then check the generated documentation or relevant AndroidX test documentation to confirm both updates are readable and accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.