https://github.com/crystal-data/crocodile
Atom extension to create docstrings for Crystal methods
https://github.com/crystal-data/crocodile
Last synced: about 2 months ago
JSON representation
Atom extension to create docstrings for Crystal methods
- Host: GitHub
- URL: https://github.com/crystal-data/crocodile
- Owner: crystal-data
- License: mit
- Created: 2020-09-28T01:26:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-28T01:32:57.000Z (almost 6 years ago)
- Last Synced: 2025-01-06T14:29:13.958Z (over 1 year ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# crocodile
Generate's basic function docstrings for Crystal function definitions.
```crystal
def flip(t : Tensor | Enumerable, axis : Int) : Tensor
...
end
```
Becomes
```crystal
# 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
```