Update documentation to reflect what the classes do

This goes against Mastodon’s documentation, but their documentation seems to be outdated here.
andregasser · Nov 27, 2023 · fae3336 · fae3336
1 parent 00a013a
commit fae3336
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxTrendMethods.kt b/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxTrendMethods.kt
@@ -10,7 +10,7 @@ import social.bigbone.api.method.TrendMethods
 /**
  * Reactive implementation of [TrendMethods].
  *
- * View hashtags that are currently being used more frequently than usual.
+ * View trending tags, statuses, or links, i.e. those that are currently being used more frequently than usual.
  * @see <a href="https://docs.joinmastodon.org/methods/trends/">Mastodon trends API methods</a>
  */
 class RxTrendMethods(client: MastodonClient) {

diff --git a/bigbone/src/main/kotlin/social/bigbone/api/method/TrendMethods.kt b/bigbone/src/main/kotlin/social/bigbone/api/method/TrendMethods.kt
@@ -8,7 +8,7 @@ import social.bigbone.api.entity.Tag
 import social.bigbone.api.entity.TrendsLink
 
 /**
- * View hashtags that are currently being used more frequently than usual.
+ * View trending tags, statuses, or links, i.e. those that are currently being used more frequently than usual.
  * @see <a href="https://docs.joinmastodon.org/methods/trends/">Mastodon trends API methods</a>
  */
 class TrendMethods(private val client: MastodonClient) {