Merge branch 'master' into pull-request-template-add-breaking-changes…

…-section
andregasser · Nov 15, 2023 · 0cac5e6 · 0cac5e6
2 parents a82770f + 6cffd23
commit 0cac5e6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/bigbone/src/main/kotlin/social/bigbone/api/method/SearchMethods.kt b/bigbone/src/main/kotlin/social/bigbone/api/method/SearchMethods.kt
@@ -34,6 +34,7 @@ class SearchMethods(private val client: MastodonClient) {
 
     /**
      * Search for content in accounts, statuses and hashtags.
+     * @see <a href="https://github.com/mastodon/documentation/issues/1336">Mastodon issue: incomplete documentation of offset/type parameters</a>
      * @param query string to search for
      * @param type to specify if you are looking for a specific typology
      * @param resolve whether to resolve non-local accounts
@@ -43,7 +44,7 @@ class SearchMethods(private val client: MastodonClient) {
      * @param maxId to return results whose id will be lesser than this one
      * @param minId to return results whose id will be newer than this one
      * @param limit to limit number of results within a range of 20-40 per category
-     * @param offset to skip the first n results
+     * @param offset to skip the first n results; only used if a type is specified
      * @see <a href="https://docs.joinmastodon.org/methods/search/">Mastodon API documentation: methods/search</a>
      */
     @JvmOverloads