(.require
 [library
  [lux (.except)
   ["$" documentation]
   [data
    ["[0]" text (.only \n)
     ["%" \\format (.only format)]]]
   [meta
    ["[0]" code]]]]
 [\\library
  ["[0]" /]])

(def .public documentation
  (.List $.Documentation)
  (list ($.module /._
                  "")

        ($.definition /.primitive)
        ($.definition /.equivalence)
        ($.definition /.monoid)
        ($.definition /.functor)
        ($.definition /.mix)
        ($.definition /.every?)
        ($.definition /.any?)

        ($.definition (/.Array it)
          "Mutable arrays.")

        ($.definition /.empty
          "An empty array of the specified size."
          [(empty size)])

        ($.definition /.size
          ""
          [(size array)])

        ($.definition /.item
          ""
          [(item index array)])

        ($.definition /.has!
          "Mutate the array by writing a value to the specified index."
          [(has! index value array)])

        ($.definition /.lacks!
          "Mutate the array by deleting the value at the specified index."
          [(lacks! index array)])

        ($.definition /.has?
          ""
          [(has? index array)])

        ($.definition /.revised!
          "Mutate the array by updating the value at the specified index."
          [(revised! index transform array)])

        ($.definition /.upsert!
          (format "Mutate the array by updating the value at the specified index."
                  \n "If there is no value, update and write the default value given.")
          [(upsert! index default transform array)])

        ($.definition /.copy!
          "Writes the contents of one array into the other."
          [(copy! length src_start src_array dest_start dest_array)])

        ($.definition /.occupancy
          "Finds out how many cells in an array are occupied."
          [(occupancy array)])

        ($.definition /.vacancy
          "Finds out how many cells in an array are vacant."
          [(vacancy array)])

        ($.definition /.only!
          "Delete every item of the array that fails to satisfy the predicate."
          [(only! p xs)])

        ($.definition /.example
          "Yields the first item in the array that satisfies the predicate."
          [(example p xs)])

        ($.definition /.example'
          "Just like 'example', but with access to the index of each value."
          [(example' p xs)])

        ($.definition /.clone
          "Yields a shallow clone of the array."
          [(clone xs)])

        ($.definition /.of_list
          ""
          [(of_list xs)])

        ($.definition /.list
          (format "Yields a list with every non-empty item in the array."
                  \n "Can use the optional default value when encountering an empty cell in the array.")
          [(list {.#None} array)
           (list {.#Some default} array)])
        ))
