Skip Menu |

This queue is for tickets about the Convert-Braille CPAN distribution.

Report information
The Basics
Id: 79067
Status: new
Priority: 0/
Queue: Convert-Braille

People
Owner: Nobody in particular
Requestors: DOHERTY [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: (no value)
Fixed in: (no value)



Subject: Insufficient documentation
The functions are bizarrely-named, and there is no documentation to explain how they are to be used. For example, the demo program shows: [2/6] brailleAsciiToDots : HELLO => 12515123123135 But a naive reader might assume that the function is for converting ASCII text into Braille dots, not a string of random numbers. Similarly, a naive reader might think that the brailleUnicodeTo* functions are designed to take UTF-8 input, while the brailleAsciiTo* functions must have only ASCII input. That's not the case at all - "Unicode" refers to the Unicode Braille dots, while ASCII refers to the ASCII symbols that can be converted to Braille.