README.md

crocodile

Generate's basic function docstrings for Crystal function definitions.

def flip(t : Tensor | Enumerable, axis : Int) : Tensor
  ...
end

Becomes

# Brief description of flip
#
# Arguments
# ---------
# t : Tensor | Enumerable
#   Brief description of t : Tensor | Enumerable
# axis : Int
#   Brief description of axis : Int
#
# Returns
# -------
# Tensor
#
# Examples
# --------
def flip(t : Tensor | Enumerable, axis : Int) : Tensor
  ...
end