Skip to content

Update Stream module docs, expose some cross product ops#3129

Merged
harendra-kumar merged 3 commits intomasterfrom
package-docs
Aug 22, 2025
Merged

Update Stream module docs, expose some cross product ops#3129
harendra-kumar merged 3 commits intomasterfrom
package-docs

Conversation

@harendra-kumar
Copy link
Member

No description provided.

Comment on lines 17 to 18
streaming enabled API. Despite a minimal API surface, Streamly offers
a wide range of capabilities.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

streamly does not have a minimal API surface. It's anything but minimal.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minimal for the functionality provided because of unification, redundancies are removed.

Comment on lines 20 to 25
Streams in Streamly feel just like lists — no steep learning curve,
no complex types. It is designed to build general purpose applications
in a truly functional manner, from simple hello-world to advanced
high-performance systems. The design emphasizes simplicity,
modularity, and code reuse with minimal building blocks. Performance
is on par with C, tuning is easy, and it’s hard to get it wrong.
Copy link
Member

@adithyaov adithyaov Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first and the last sentence can probably be rephrased.

unicode processing, string interpolation. The fundamental unifying
theme in all functionality is modularity using basic streaming and
array abstractions.
@streamly-core@ is a Haskell standard library built on top of @base@
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haskell standard library?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it provides all the core functionality that you need for more than basic programming. Only things its probably lacking is effects and logging.

@streamly-core@ is a Haskell standard library built on top of @base@
and GHC boot libraries only. Stream processing abstractions include
streams, scans, folds, parsers; and console I/O, file I/O; text
processing, and string interpolation. Array abstractions include
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string interpolation can be removed.

This is a hard statement to read.

alternative to many disparate packages, such as @streaming, pipes,
conduit, list-t, logict, foldl, attoparsec, array, primitive,
vector, vector-algorithms, binary, cereal, store, bytestring, text,
stringsearch, interpolate, filepath, and path@.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, str is only a partial alternative to interpolate

streamly.cabal Outdated
serialization; generalizes parsers to any input type and unifies
attoparsec, parsec use cases with better performance; provides
streaming fileIO — all with a clean, consistent, well-integrated and
streaming enabled API. Despite a minimal API surface, Streamly offers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a minimal API surface.

streamly.cabal Outdated
Comment on lines 20 to 24
Streams in Streamly feel just like lists — no steep learning curve,
no complex types. It is designed to build general purpose applications
in a truly functional manner, from simple hello-world to advanced
high-performance systems. The design emphasizes simplicity,
modularity, and code reuse with minimal building blocks. Performance
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments above.

@harendra-kumar harendra-kumar merged commit 86fcc8a into master Aug 22, 2025
20 of 22 checks passed
@harendra-kumar harendra-kumar deleted the package-docs branch August 22, 2025 04:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments