Skip to content

Commit 9b1cba4

Browse files
committed
Add docstring for @register_unit
1 parent 8f2cc24 commit 9b1cba4

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

src/register_units.jl

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,14 @@ function update_all_values(name_symbol, unit)
1515
end
1616
end
1717

18-
# Register
19-
macro register_unit(name, value)
20-
return esc(_register_unit(name, value))
18+
"""
19+
@register_unit symbol value
20+
21+
Register a new unit under the given symbol to have
22+
a particular value.
23+
"""
24+
macro register_unit(symbol, value)
25+
return esc(_register_unit(symbol, value))
2126
end
2227

2328
function _register_unit(name::Symbol, value)

0 commit comments

Comments
 (0)