From e46971500650a5dcf1c9734341de8aeaf4360468 Mon Sep 17 00:00:00 2001
From: Shivam <11shivam00@gmail.com>
Date: Wed, 30 Oct 2024 07:33:45 +0530
Subject: [PATCH] docs: improve README examples of `math/iter/sequences`

PR-URL: https://github.com/stdlib-js/stdlib/pull/1779
Ref: https://github.com/stdlib-js/stdlib/issues/1577

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
---
 .../@stdlib/math/iter/sequences/README.md     | 41 +++++++++++++++++--
 .../math/iter/sequences/examples/index.js     | 41 +++++++++++++++++--
 2 files changed, 75 insertions(+), 7 deletions(-)

diff --git a/lib/node_modules/@stdlib/math/iter/sequences/README.md b/lib/node_modules/@stdlib/math/iter/sequences/README.md
index c04ac075e941..2eab765846dd 100644
--- a/lib/node_modules/@stdlib/math/iter/sequences/README.md
+++ b/lib/node_modules/@stdlib/math/iter/sequences/README.md
@@ -87,15 +87,48 @@ The namespace contains the following functions for creating iterator protocol-co
 
 ## Examples
 
-<!-- TODO: better examples -->
-
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var objectKeys = require( '@stdlib/utils/keys' );
 var ns = require( '@stdlib/math/iter/sequences' );
 
-console.log( objectKeys( ns ) );
+// Create iterators for generating square and cube numbers:
+var squares = ns.iterSquaresSeq();
+var cubes = ns.iterCubesSeq();
+
+// Iterate over both sequences and log the first five pairs:
+var square;
+var cube;
+var i;
+for ( i = 0; i < 5; i++ ) {
+    square = squares.next().value;
+    cube = cubes.next().value;
+    console.log( 'Square: %d, Cube: %d', square, cube );
+}
+
+// Calculate the sum of the first ten Fibonacci numbers:
+var fibonacci = ns.iterFibonacciSeq({
+    'iter': 10
+});
+var sum = 0;
+var v = fibonacci.next();
+while ( v.done === false ) {
+    sum += v.value;
+    v = fibonacci.next();
+}
+console.log( 'Sum of first ten Fibonacci numbers: %d', sum );
+
+// Generate prime numbers:
+var primes = ns.iterPrimesSeq({
+    'iter': 10
+});
+
+console.log( 'First ten prime numbers:' );
+v = primes.next();
+while ( v.done === false ) {
+    console.log( v.value );
+    v = primes.next();
+}
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js
index b34f8f4522ad..bcb7bfa6b2a4 100644
--- a/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js
+++ b/lib/node_modules/@stdlib/math/iter/sequences/examples/index.js
@@ -18,7 +18,42 @@
 
 'use strict';
 
-var objectKeys = require( '@stdlib/utils/keys' );
-var ns = require( './../lib' );
+var ns = require('./../lib');
 
-console.log( objectKeys( ns ) );
+// Create iterators for generating square and cube numbers:
+var squares = ns.iterSquaresSeq();
+var cubes = ns.iterCubesSeq();
+
+// Iterate over both sequences and log the first five pairs:
+var square;
+var cube;
+var i;
+for ( i = 0; i < 5; i++ ) {
+	square = squares.next().value;
+	cube = cubes.next().value;
+	console.log( 'Square: %d, Cube: %d', square, cube );
+}
+
+// Calculate the sum of the first 10 Fibonacci numbers:
+var fibonacci = ns.iterFibonacciSeq({
+	'iter': 10
+});
+var sum = 0;
+var v = fibonacci.next();
+while ( v.done === false ) {
+	sum += v.value;
+	v = fibonacci.next();
+}
+console.log( 'Sum of first 10 Fibonacci numbers: %d', sum );
+
+// Generate prime numbers:
+var primes = ns.iterPrimesSeq({
+	'iter': 10
+});
+
+console.log( 'First ten prime numbers:' );
+v = primes.next();
+while ( v.done === false ) {
+	console.log( v.value );
+	v = primes.next();
+}