Batch mode specification *vs* implementation

[BartMassey]

The crate documentation is confusing: I'm not exactly sure what this is generating in batch mode?

The documentation says that it generates all "permutations" of a given sequence: the documentation for utils::gen_sequences() shows an example with two identical notes (C:4, C:4). On the other hand, gen_sequences() appears to generate a Cartesian Product of note sequences of the given length via itertools::Itertools::multi_cartesian_product(). The example result would then contain duplicate melody sequences…

My guess is that the intent is indeed to do what gen_sequences() currently does: generate the set of all sequences of the given length drawn from the given note alphabet set. I'd suggest:

• Correcting the documentation throughout not to refer to "permutation".
• Calling the input note alphabet a "set" rather than a "sequence" throughout.
• Fixing the example to not contain duplicate notes.
• Normalizing the input note alphabet at some point so that it is actually a set, possibly issuing a warning if it contained duplicate elements.

[allthemusicllc]

@BartMassey these are fair points, and we're working on a new release that will correct some of the issues you pointed out, as well as add some new features. Thank you for taking the time to read through the docs, wasn't sure anyone would do that and we appreciate the feedback.