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

Documentation of the API could be more helpful #126

Open
bruce-hill opened this issue Mar 19, 2019 · 1 comment
Open

Documentation of the API could be more helpful #126

bruce-hill opened this issue Mar 19, 2019 · 1 comment

Comments

@bruce-hill
Copy link

The README says "Termbox's interface only consists of 12 functions", which is not really accurate (there's 21 functions), and lists just the function names. I think it would be helpful to give argument names (e.g. tb_change_cell(x, y, ch, fg, bg) instead of just tb_change_cell()) and either list all 21 functions, or explicitly say that the listed functions are only the most commonly used ones, but the API has a some other functions too.

@osa1
Copy link
Contributor

osa1 commented Oct 1, 2019

In addition, it'd be helpful to mention the expected encoding of chars in tb_change_cell. I think it's wchar_t (because the value is later passed to wcwidth()) but maybe I'm missing something because the actual type is uint32_t instead of wchar_t, perhaps for a reason.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants