Skip to content

Commit be2a18f

Browse files
author
AndreyGeonya
committed
fix js-doc fonfigand small fixes in primes jsdoc
1 parent f7ded3a commit be2a18f

4 files changed

Lines changed: 12 additions & 12 deletions

File tree

‎doc-config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"./src/graphs/shortest-path/",
1010
"./src/graphs/spanning-trees/",
1111
"./src/data-structures/",
12-
"./src/combinatorics/"
12+
"./src/combinatorics/",
1313
"./src/primes/"
1414
],
1515
"includePattern": ".+\\.js(doc)?$",

‎src/primes/is-prime.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
* For example for number 104743 it should return true, for 104744 - false.
77
*
88
* @module primes/is-prime
9-
* @param {Number} number - Number that we check on prime
10-
* @returns {Boolean} Will return true if provided number is prime
9+
* @param {Number} number - Number that we check on prime.
10+
* @returns {Boolean} Will return true if provided number is prime.
1111
*
1212
* @example
13-
* var isPrime = require('path/to/primes/is-prime').isPrime;
13+
* var isPrime = require('path-to-algorithms/src/is-prime').isPrime;
1414
*
1515
* console.log(isPrime(7)); // true
1616
* console.log(isPrime(18)); // false

‎src/primes/prime-factor-tree.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
* [2, 3, 3].
88
*
99
* @module primes/prime-factor-tree
10-
* @param {Number} number - Number for which method will find all primes
11-
* @returns {Array} List of available primes for provided number
10+
* @param {Number} number - Number for which method will find all primes.
11+
* @returns {Array} List of available primes for provided number.
1212
*
1313
* @example
14-
* var primeFactorTree = require('path/to/primes/prime-factor-tree')
14+
* var primeFactorTree = require('path-to-algorithms/src/prime-factor-tree')
1515
* .primeFactorTree;
1616
*
1717
* console.log(primeFactorTree(18)); // [2, 3, 3]

‎src/primes/sieve-of-eratosthenes.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@
99
* Returns list of primes up to specified limit.
1010
*
1111
* For example, for limit 10 it should return following list of primes:
12-
* [2, 3, 5, 7]
12+
* [2, 3, 5, 7].
1313
*
1414
* @module primes/sieve-of-eratosthenes
1515
* @param {Number} limit - Algorithm will returns list of primes up to
16-
* specified limit
17-
* @returns {Array} Will return list with all prime numbers up to provided
18-
* limit
16+
* specified limit.
17+
* @returns {Array} Will return list with all prime numbers up to provided.
18+
* limit.
1919
*
2020
* @example
21-
* var sieveOfEratosthenes = require('path/to/primes/sieve-of-eratosthenes')
21+
* var sieveOfEratosthenes = require('path-to-algorithms/src/sieve-of-eratosthenes')
2222
* .sieveOfEratosthenes;
2323
*
2424
* console.log(sieveOfEratosthenes(12)); // [2, 3, 5, 7, 11]

0 commit comments

Comments
 (0)