Skip to content

Commit eee7ad9

Browse files
committed
functions: add puppet-strings docs
1 parent 7d086f9 commit eee7ad9

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

functions/bytes_to_size.pp

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# @summary Convert a number of bytes to a size format that LVM can understand
2+
#
3+
# @return LVM-formatted size
4+
#
5+
# @example Return `200g`
6+
#
7+
# lvm::bytes_to_size(214748364800)
18
function lvm::bytes_to_size (
29
Numeric $size,
310
) {

functions/size_to_bytes.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary Convert an LVM size to bytes, the opposite of `lvm::bytes_to_size`
2+
#
3+
# @return byte value of LVM-formatted size
14
function lvm::size_to_bytes (
25
String $size,
36
) {

0 commit comments

Comments
 (0)