Skip to content

Commit 93e8686

Browse files
committed
clarified javadoc for isCorrectedSearch and getSearchSuggestions in SearchExtractor
1 parent 3757541 commit 93e8686

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

extractor/src/main/java/org/schabi/newpipe/extractor/search/SearchExtractor.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ public String getSearchString() {
2828
/**
2929
* The search suggestion provided by the service.
3030
* <p>
31-
* This method may also return the corrected query,
32-
* see {@link SearchExtractor#isCorrectedSearch()}.
31+
* This method also returns the corrected query if
32+
* {@link SearchExtractor#isCorrectedSearch()} is true.
3333
*
3434
* @return a suggestion to another query, the corrected query, or an empty String.
3535
* @throws ParsingException
@@ -49,8 +49,7 @@ public String getName() {
4949
}
5050

5151
/**
52-
* When you search on some service, it can give you another and corrected request.
53-
* This method says if it's the case.
52+
* Tell if the search was corrected by the service (if it's not exactly the search you typed).
5453
* <p>
5554
* Example: on YouTube, if you search for "pewdeipie",
5655
* it will give you results for "pewdiepie", then isCorrectedSearch should return true.

0 commit comments

Comments
 (0)