Skip to content

Commit b1adbf1

Browse files
committed
cleanup docs
1 parent 6129f6d commit b1adbf1

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

src/UnicodeGraphics.jl

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ export blockize, brailize, blockize!, brailize!
77

88
"""
99
brailize(a, cutoff=0)
10+
1011
Convert an array to a block unicode string, filling values above the cutoff point.
1112
"""
1213
blockize(a, cutoff=0) = blockize!(initblock(size(a)), a, cutoff)
@@ -17,13 +18,9 @@ initblock(y, x) = Array{Char,2}(undef, x + 1, (y - 1) ÷ 2 + 1)
1718

1819
"""
1920
blockize!(out, a, cutoff=0)
21+
2022
Convert an array to a braile unicode string, filling the `out` array.
2123
Calculation of array dims is a little complicated:
22-
23-
```julia
24-
yrange, xrange = axes(a)
25-
out = Array{Char,2}(undef, length(xrange) + 1, (length(yrange) - 1) ÷ 2 + 1)
26-
```
2724
"""
2825
blockize!(out, a, cutoff=0) = join(block_array!(out, a, cutoff))
2926

@@ -52,6 +49,7 @@ const braile_hex = ((0x01, 0x08), (0x02, 0x10), (0x04, 0x20), (0x40, 0x80))
5249

5350
"""
5451
brailize(a, cutoff=0)
52+
5553
Convert an array to a braile unicode string, filling values above the cutoff point.
5654
"""
5755
brailize(a, cutoff=0) = brailize!(initbraile(size(a)), a, cutoff)
@@ -62,13 +60,8 @@ initbraile(y, x) = Array{Char,2}(undef, (x - 1) ÷ 2 + 2, (y - 1) ÷ 4 + 1)
6260

6361
"""
6462
brailize!(out, a, cutoff=0)
65-
Convert an array to a braile unicode string, filling the `out` array.
66-
Calculation of array dims is a little complicated:
6763
68-
```julia
69-
yrange, xrange = axes(a)
70-
out = Array{Char,2}(undef, (length(xrange) - 1) ÷ 2 + 2, (length(yrange) - 1) ÷ 4 + 1)
71-
```
64+
Convert an array to a braile unicode string, filling the `out` array.
7265
"""
7366
brailize!(out, a, cutoff=0) = join(braile_array!(out, a, cutoff))
7467

0 commit comments

Comments
 (0)