From 0b294285ceecc51ee4077e42955154329c35c0c8 Mon Sep 17 00:00:00 2001 From: Luca Kellermann Date: Mon, 9 Sep 2024 04:10:41 +0200 Subject: [PATCH] chore(core): update KDoc for methods of Kord --- core/src/commonMain/kotlin/Kord.kt | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/core/src/commonMain/kotlin/Kord.kt b/core/src/commonMain/kotlin/Kord.kt index b51bd24dafc..ca53f509ce2 100644 --- a/core/src/commonMain/kotlin/Kord.kt +++ b/core/src/commonMain/kotlin/Kord.kt @@ -380,7 +380,7 @@ public class Kord( rest.sku.listSkus(selfId).map { Sku(it, this) } /** - * Requests to get a list of [Entitlement]s. + * Requests to get all [Entitlement]s for this application. * * @throws [RequestException] if anything went wrong during the request. */ @@ -398,8 +398,11 @@ public class Kord( } /** - * Requests to create a new [test entitlement][Entitlement] to a [Sku] with the given [skuId] for a given [ownerId] - * and [ownerType]. Discord will act as though that owner has entitlement to your premium offering. + * Requests to create a new [test entitlement][Entitlement] to a [Sku] with the given [skuId] for an owner with the + * given [ownerId] and [ownerType]. Discord will act as though that owner has entitlement to your premium offering. + * + * The returned [Entitlement] will not contain [startsAt][Entitlement.startsAt] and [endsAt][Entitlement.endsAt], as + * it's valid in perpetuity. * * @throws RestRequestException if something went wrong during the request. */ @@ -419,6 +422,9 @@ public class Kord( * Requests to create a new [test entitlement][Entitlement] to a [Sku] with the given [skuId] for a given [user]. * Discord will act as though that user has entitlement to your premium offering. * + * The returned [Entitlement] will not contain [startsAt][Entitlement.startsAt] and [endsAt][Entitlement.endsAt], as + * it's valid in perpetuity. + * * @throws RestRequestException if something went wrong during the request. */ public suspend fun createTestEntitlement(skuId: Snowflake, user: UserBehavior): Entitlement = @@ -428,6 +434,9 @@ public class Kord( * Requests to create a new [test entitlement][Entitlement] to a [Sku] with the given [skuId] for a given [guild]. * Discord will act as though that guild has entitlement to your premium offering. * + * The returned [Entitlement] will not contain [startsAt][Entitlement.startsAt] and [endsAt][Entitlement.endsAt], as + * it's valid in perpetuity. + * * @throws RestRequestException if something went wrong during the request. */ public suspend fun createTestEntitlement(skuId: Snowflake, guild: GuildBehavior): Entitlement =