Update the docs regarding RingArray

composewell · Oct 11, 2024 · 6b5c29d · 6b5c29d
1 parent a3bd8d1
commit 6b5c29d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/docs/User/Tutorials/performance-considerations.md b/docs/User/Tutorials/performance-considerations.md
@@ -107,14 +107,14 @@ arrays store data without an additional heap pointer wrapper
 
 * Streamly.Data.Array
 * Streamly.Data.MutArray
-* Streamly.Internal.Data.Ring
+* Streamly.Internal.Data.RingArray
 
 For storing boxed heap objects, boxed arrays are provided in the following
 modules:
 
 * Streamly.Data.Array.Generic
 * Streamly.Data.MutArray.Generic
-* Streamly.Internal.Data.Ring.Generic
+* Streamly.Internal.Data.RingArray.Generic
 
 Unboxed arrays can be pinned (cannot be moved by GC) or
 unpinned. However, pinned or unpinned nature of the memory is not

diff --git a/docs/User/Tutorials/replacing-other-packages.md b/docs/User/Tutorials/replacing-other-packages.md
@@ -113,8 +113,8 @@ The relevant modules in streamly are:
 * `Streamly.Data.Array.Generic`: immutable, boxed arrays
 * `Streamly.Data.MutArray`: mutable, unboxed, pinned, unpinned arrays
 * `Streamly.Data.MutArray.Generic`: mutable, boxed arrays
-* `Streamly.Internal.Data.Ring`: unboxed ring buffer
-* `Streamly.Internal.Data.Ring.Generic`: boxed ring buffer
+* `Streamly.Internal.Data.RingArray`: unboxed ring buffer
+* `Streamly.Internal.Data.RingArray.Generic`: boxed ring buffer
 
 | Package           | Streamly Type           |
 |-------------------|-------------------------|

diff --git a/docs/User/Tutorials/types-and-modules.md b/docs/User/Tutorials/types-and-modules.md
@@ -17,17 +17,17 @@ The following table lists the modules and types for monadic stream producers
 
 ## Arrays
 
-| Module                              | Type         | Description                                    |
-|-------------------------------------|--------------|------------------------------------------------|
-| Streamly.Data.Array                 | Array a      | Immutable, unboxed, pinned and unpinned arrays |
-| Streamly.Data.MutArray              | MutArray a   | Mutable, unboxed, pinned and unpinned arrays   |
-| Streamly.Data.Array.Generic         | Array a      | Immutable, boxed arrays                        |
-| Streamly.Data.MutArray.Generic      | MutArray a   | Mutable, boxed arrays                          |
-| Streamly.Data.MutByteArray          | MutByteArray | Mutable byte arrays                            |
-| Streamly.Data.MutByteArray          | Unbox a      | Fixed length data serialization                |
-| Streamly.Data.MutByteArray          | Serialize a  | Variable length data serialization             |
-| Streamly.Internal.Data.Ring         | Ring a       | Unboxed ring buffer                            |
-| Streamly.Internal.Data.Ring.Generic | Ring a       | Boxed ring buffer                              |
+| Module                                   | Type         | Description                                    |
+|------------------------------------------|--------------|------------------------------------------------|
+| Streamly.Data.Array                      | Array a      | Immutable, unboxed, pinned and unpinned arrays |
+| Streamly.Data.MutArray                   | MutArray a   | Mutable, unboxed, pinned and unpinned arrays   |
+| Streamly.Data.Array.Generic              | Array a      | Immutable, boxed arrays                        |
+| Streamly.Data.MutArray.Generic           | MutArray a   | Mutable, boxed arrays                          |
+| Streamly.Data.MutByteArray               | MutByteArray | Mutable byte arrays                            |
+| Streamly.Data.MutByteArray               | Unbox a      | Fixed length data serialization                |
+| Streamly.Data.MutByteArray               | Serialize a  | Variable length data serialization             |
+| Streamly.Internal.Data.RingArray         | RingArray a  | Unboxed ring buffer                            |
+| Streamly.Internal.Data.RingArray.Generic | RingArray a  | Boxed ring buffer                              |
 
 ## Unicode Operations