Documentation for permutations(a) (#67)

* Add permutations(a) to list of functions

* permutations(a) docstring

Mention lexicographic order in permutations(a) docstring

* Tickmarks

Author: pbouffard

README.md

@@ -30,6 +30,7 @@ This library provides the following functions:
  - `stirlings1(n, k, signed=false)`: returns the `(n,k)`-th Stirling number of the first kind; the number is signed if `signed` is true; returns a `BigInt` only if given a `BigInt`.
  - `stirlings2(n, k)`: returns the `(n,k)`-th Stirling number of the second kind; returns a `BigInt` only if given a `BigInt`.
  - `nthperm(a, k)`: Compute the `k`th lexicographic permutation of the vector `a`.
+ - `permutations(a)`: Generate all permutations of an indexable object `a` in lexicographic order.
 
 Young diagrams
 --------------

src/permutations.jl

@@ -21,7 +21,7 @@ Base.length(p::Permutations) = (0 <= p.t <= length(p.a)) ? factorial(length(p.a)
 """
     permutations(a)
 
-Generate all permutations of an indexable object `a`. Because the number of permutations
+Generate all permutations of an indexable object `a` in lexicographic order. Because the number of permutations
 can be very large, this function returns an iterator object.
 Use `collect(permutations(a))` to get an array of all permutations.
 """