Skip to content

crystal-data/crocodile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

Atom extension to create docstrings for Crystal methods

Resources

License

Stars

Watchers

Forks

Packages

No packages published