Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make more distinction between Yes and N/A in the readme table #463

Merged
merged 1 commit into from
Feb 23, 2021

Conversation

prusnak
Copy link
Collaborator

@prusnak prusnak commented Feb 22, 2021

... by using checkmark ✓ and cross ✗

The original formatting was making the table quite hard to grasp as there were so many letters present on screen at once.

This is how the rendered readme looks like: https://github.com/prusnak/HWI/tree/readme-table#device-support

We might even consider using ❌ and ✅ emojis, but these might not be as widely supported (they are in the Unicode 6.0 standard from 2010). The characters I used are part of Unicode 1.1 from 1993.

@achow101
Copy link
Member

The table actual shows a tri-state. Yes means "supported by firmware and implemented in HWI". No means "supported by firmware and not implemented by HWI" (we don't have any on this table AFAICT). N/A means "not supported by the firmware". So just ✓ and ✗ is not sufficient.

A previous PR which implemented something similar was closed because of concerns with how this would be displayed in text editors, although I think that used Github's emojis rather than unicode. I think most terminals and text editors support unicode so this probably isn't an issue, especially with characters that are part of a very old unicode version.

@prusnak
Copy link
Collaborator Author

prusnak commented Feb 22, 2021

Right. There is no "No" in the table at the moment (good job!).

I updated the PR to include the legend and replaced cross with dash for N/A.

@prusnak prusnak added the docs label Feb 22, 2021
@achow101
Copy link
Member

ACK 40c6887

@achow101 achow101 merged commit a1a7b3d into bitcoin-core:master Feb 23, 2021
@prusnak prusnak deleted the readme-table branch February 23, 2021 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants