Mention that dot-character mapping can be one-to-many, and what happe…

…ns with virtual dots
liblouis · May 29, 2020 · 67a09fc · 67a09fc
1 parent 43ceb24
commit 67a09fc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/tools/brl_checks.c b/tools/brl_checks.c
@@ -384,7 +384,9 @@ check_cursor_pos(const char *tableList, const char *str, const int *expected_pos
 
 /** Check if a display table maps characters to the right dots.
  *
- * The dots are read as Unicode braille.
+ * The dots are read as Unicode braille. Multiple input characters are
+ * allowed to map to the same dot pattern. Virtual dots in the actual
+ * output are discarded.
  *
  * @return 0 if the result is as expected and 1 otherwise.
  */

diff --git a/tools/brl_checks.h b/tools/brl_checks.h
@@ -127,7 +127,9 @@ check_cursor_pos(const char *tableList, const char *str, const int *expected_pos
 
 /** Check if a display table maps characters to the right dots.
  *
- * The dots are read as Unicode braille.
+ * The dots are read as Unicode braille. Multiple input characters are
+ * allowed to map to the same dot pattern. Virtual dots in the actual
+ * output are discarded.
  *
  * @return 0 if the result is as expected and 1 otherwise.
  */