Merge pull request #301 from aspriddell/add-skill-record-remark

add skill records disclaimer
dragonfruitnetwork · Mar 31, 2022 · debe93b · debe93b
2 parents 608d1a8 + 1a6ab28
commit debe93b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/DragonFruit.Six.Api/Seasonal/SeasonStatsExtensions.cs b/DragonFruit.Six.Api/Seasonal/SeasonStatsExtensions.cs
@@ -72,6 +72,7 @@ public static Task<SeasonalStatsResponse> GetSeasonalStatsAsync(this Dragon6Clie
         /// <remarks>
         /// This call is able to return results for multiple accounts spanning large numbers of seasons, ranking boards and regions. If you need a single season, use <see cref="GetSeasonalStatsAsync(DragonFruit.Six.Api.Dragon6Client,DragonFruit.Six.Api.Accounts.Entities.UbisoftAccount,int,DragonFruit.Six.Api.Seasonal.Enums.BoardType,DragonFruit.Six.Api.Seasonal.Enums.Region,System.Threading.CancellationToken)"/> instead.
         /// Elements are returned ungrouped and unordered due to the large ways the dataset could be sorted. It is recommended to sort then convert the returned <see cref="IEnumerable{T}"/> to an array afterwards.
+        /// This does not return stats for the current season (either -1 or the positive id), use the other overload to get the current season
         /// </remarks>
         public static Task<IEnumerable<SeasonalStats>> GetSeasonalStatsRecordsAsync(this Dragon6Client client, IEnumerable<UbisoftAccount> accounts, IEnumerable<int> seasonIds, BoardType boards, Region regions, CancellationToken token = default)
         {
@@ -92,6 +93,7 @@ public static Task<IEnumerable<SeasonalStats>> GetSeasonalStatsRecordsAsync(this
         /// <remarks>
         /// This call is able to return results for multiple accounts spanning large numbers of seasons, ranking boards and regions. If you need a single season, use <see cref="GetSeasonalStatsAsync(DragonFruit.Six.Api.Dragon6Client,DragonFruit.Six.Api.Accounts.Entities.UbisoftAccount,int,DragonFruit.Six.Api.Seasonal.Enums.BoardType,DragonFruit.Six.Api.Seasonal.Enums.Region,System.Threading.CancellationToken)"/> instead.
         /// Elements are returned ungrouped and unordered due to the large ways the dataset could be sorted. It is recommended to sort then convert the returned <see cref="IEnumerable{T}"/> to an array afterwards.
+        /// This does not return stats for the current season (either -1 or the positive id), use the other overload to get the current season
         /// </remarks>
         public static Task<IEnumerable<SeasonalStats>> GetSeasonalStatsRecordsAsync(this Dragon6Client client, UbisoftAccount account, IEnumerable<int> seasonIds, BoardType boards, Region regions, CancellationToken token = default)
         {