gizak / gizak/termui

Document that Braille patterns may require font overrides

Open
#277 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
13.6k
Forks
819
PR merge metrics
No merged PRs in 30d

Description

As discussed on https://github.com/cjbassi/ytop/issues/79 the use of Braille patterns to plot graphs may require the terminal to be set to use a font like Symbola for that part of the Unicode range. Some other fonts also display the “off” dots (for example as empty circles)—Braille patterns are somewhat less useful for graph plotting if a font like that is selected. I'd like to propose that this be mentioned somewhere in the documentation so that developers using this library know they might have to warn their users that the Braille patterns might not show as intended, depending on one's choice of fonts. (See screenshots on the ytop issue linked above.)

The Braille Patterns block was originally designed for representing Braille, for example in books that teach sighted readers how to transcribe things into Braille. It was not originally designed just for graphical patterns. So it's understandable if some fonts show the “off” dots and others do not.

Thanks.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the discussion in issue #79 first, then inspect the repository's documentation to find the appropriate place for a note about Braille-pattern font rendering. Add guidance that terminal fonts may display Braille patterns differently and that developers may need to warn users; done means the caveat is documented in a discoverable location.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.