Hint at other version in docs

polyadic · Jan 14, 2025 · ce7a408 · ce7a408
1 parent 1da0f3e
commit ce7a408
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/Funcky/Sequence/Sequence.CycleMaterialized.cs b/Funcky/Sequence/Sequence.CycleMaterialized.cs
@@ -2,7 +2,13 @@ namespace Funcky;
 
 public static partial class Sequence
 {
-    /// <inheritdoc cref="CycleRange{TSource}(IEnumerable{TSource})"/>
+    /// <summary>
+    /// Generates a sequence that contains the same sequence of elements over and over again as an endless generator.
+    /// </summary>
+    /// <typeparam name="TSource">Type of the elements to be cycled.</typeparam>
+    /// <param name="source">The sequence of elements which are cycled. Throws an exception if the sequence is empty.</param>
+    /// <returns>Returns an infinite IEnumerable repeating the same sequence of elements.</returns>
+    /// <remarks>Use <see cref="CycleRange{TSource}"/> if you need to cycle a lazy sequence.</remarks>
     [Pure]
     public static IEnumerable<TSource> CycleMaterialized<TSource>(IReadOnlyCollection<TSource> source)
         => source.Count > 0

diff --git a/Funcky/Sequence/Sequence.CycleRange.cs b/Funcky/Sequence/Sequence.CycleRange.cs
@@ -11,6 +11,7 @@ public static partial class Sequence
     /// <typeparam name="TSource">Type of the elements to be cycled.</typeparam>
     /// <param name="source">The sequence of elements which are cycled. Throws an exception if the sequence is empty.</param>
     /// <returns>Returns an infinite IEnumerable repeating the same sequence of elements.</returns>
+    /// <remarks>Use <see cref="CycleMaterialized{TSource}"/> if you need to cycle an already materialized sequence.</remarks>
     [Pure]
     public static IBuffer<TSource> CycleRange<TSource>(IEnumerable<TSource> source)
         => CycleBuffer.Create(source);

diff --git a/Funcky/Sequence/Sequence.RepeatMaterialized.cs b/Funcky/Sequence/Sequence.RepeatMaterialized.cs
@@ -2,7 +2,14 @@ namespace Funcky;
 
 public static partial class Sequence
 {
-    /// <inheritdoc cref="RepeatRange{TSource}(IEnumerable{TSource},int)"/>
+    /// <summary>
+    /// Generates a sequence that contains the same sequence of elements the given number of times.
+    /// </summary>
+    /// <typeparam name="TSource">Type of the elements to be repeated.</typeparam>
+    /// <param name="source">The sequence of elements to be repeated.</param>
+    /// <param name="count">The number of times to repeat the value in the generated sequence.</param>
+    /// <returns>Returns an infinite IEnumerable cycling through the same elements.</returns>
+    /// <remarks>Use <see cref="RepeatRange{TSource}"/> if you need to cycle a lazy sequence.</remarks>
     [Pure]
     public static IEnumerable<TSource> RepeatMaterialized<TSource>(IReadOnlyCollection<TSource> source, int count)
         => Enumerable.Repeat(source, count).SelectMany(Identity);

diff --git a/Funcky/Sequence/Sequence.RepeatRange.cs b/Funcky/Sequence/Sequence.RepeatRange.cs
@@ -9,6 +9,7 @@ public static partial class Sequence
     /// <param name="source">The sequence of elements to be repeated.</param>
     /// <param name="count">The number of times to repeat the value in the generated sequence.</param>
     /// <returns>Returns an infinite IEnumerable cycling through the same elements.</returns>
+    /// <remarks>Use <see cref="RepeatMaterialized{TSource}"/> if you need to cycle an already materialized sequence.</remarks>
     [Pure]
     public static IBuffer<TSource> RepeatRange<TSource>(IEnumerable<TSource> source, int count)
         => CycleBuffer.Create(source, count);