Skip to content

Commit 8e08a2a

Browse files
committed
Improved docs
1 parent 020acfe commit 8e08a2a

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

extractor/src/main/java/org/schabi/newpipe/extractor/comments/CommentsInfoItemExtractor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
public interface CommentsInfoItemExtractor extends InfoItemExtractor {
1313

1414
/**
15-
* Return the like count of the comment, or -1 if it's unavailable<br/>
15+
* Return the (approximate) like count of the comment, or -1 if it's unavailable<br/>
1616
* NOTE: Currently only implemented for YT {@link YoutubeCommentsInfoItemExtractor#getLikeCount()}
1717
* with limitations
1818
*

extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeCommentsInfoItemExtractor.java

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,18 @@ public DateWrapper getUploadDate() throws ParsingException {
7373

7474
/**
7575
* @implNote The method is parsing internally a localized string.<br/>
76-
* This will fail for other languages than English.
77-
* However as long as the Extractor only uses "en-GB"
78-
* (as seen in {@link org.schabi.newpipe.extractor.services.youtube.YoutubeService#SUPPORTED_LANGUAGES})
79-
* everything will work fine.<br/>
76+
* <ul>
77+
* <li>
78+
* More than >1k likes will result in an inaccurate number
79+
* </li>
80+
* <li>
81+
* This will fail for other languages than English.
82+
* However as long as the Extractor only uses "en-GB"
83+
* (as seen in {@link org.schabi.newpipe.extractor.services.youtube.YoutubeService#SUPPORTED_LANGUAGES})
84+
* everything will work fine.
85+
* </li>
86+
* </ul>
87+
* <br/>
8088
* Consider using {@link #getTextualVoteCount()}
8189
*/
8290
@Override

0 commit comments

Comments
 (0)