From 477d9b7a5be6b5c58fb5666489517dc9e46c7929 Mon Sep 17 00:00:00 2001 From: Nick Waddoups Date: Tue, 7 Jan 2025 17:34:49 -0700 Subject: [PATCH] Added outline for documentation --- docs/reference/adaptors.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/reference/adaptors.rst b/docs/reference/adaptors.rst index ea0f6d76..21236813 100644 --- a/docs/reference/adaptors.rst +++ b/docs/reference/adaptors.rst @@ -1081,6 +1081,18 @@ You can pass a reference to a sequence into an adaptor using :func:`flux::ref` o :see also: * :func:`flux::filter` +``permutations`` +^^^^^^^^^^^^^^^^ + +.. function:: + template + requires(not infinite_sequence) + auto permutations(Seq seq) -> bidirectional_sequence auto + + :param seq: A non-infinite sequence + + :returns: A bidirectional sequence yielding permutations of :var:`seq`. + ``pairwise`` ^^^^^^^^^^^^ @@ -1997,4 +2009,4 @@ You can pass a reference to a sequence into an adaptor using :func:`flux::ref` o * - :concept:`read_only_sequence` - All inputs are read-only * - :concept:`const_iterable_sequence` - - All inputs are const-iterable \ No newline at end of file + - All inputs are const-iterable