File tree Expand file tree Collapse file tree 1 file changed +6
-1
lines changed
osu.Game/Rulesets/Difficulty Expand file tree Collapse file tree 1 file changed +6
-1
lines changed Original file line number Diff line number Diff line change @@ -154,10 +154,15 @@ public List<TimedDifficultyAttributes> CalculateTimed([NotNull] IEnumerable<Mod>
154154 /// a lazy-evaluated enumerable of <see cref="TimedDifficultyAttributes"/> representing the difficulty at every relevant time value in the beatmap.
155155 /// </summary>
156156 /// <remarks>
157+ /// <para>
157158 /// The returned task represents the operations related to the initialisation of the difficulty calculation (pre-processing).
158- /// The pre-processing in question can be cancelled via <paramref name="cancellationToken"/>.
159+ /// The task will block the calling thread; use <see cref="Task.Run(System.Action)"/> if this is not desired.
160+ /// The task can be cancelled via <paramref name="cancellationToken"/>.
161+ /// </para>
162+ /// <para>
159163 /// Once the pre-processing is done, the returned enumerable no longer respects the <paramref name="cancellationToken"/>.
160164 /// Enumeration will be lazy and blocking; callers are expected to stop enumerating if they no longer wish to receive timed difficulty attributes.
165+ /// </para>
161166 /// </remarks>
162167 /// <param name="mods">The mods that should be applied to the beatmap.</param>
163168 /// <param name="cancellationToken">The cancellation token for pre-processing.</param>
You can’t perform that action at this time.
0 commit comments