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

Scope of API #1

Open
keleshev opened this issue Oct 6, 2015 · 1 comment
Open

Scope of API #1

keleshev opened this issue Oct 6, 2015 · 1 comment

Comments

@keleshev
Copy link
Owner

keleshev commented Oct 6, 2015

Right now, apart from Terminal.Termplate module, the library exposes Terminal.Text.Color, Terminal.Text.Color.Background, Terminal.Text.Mode, and Terminal.Text.Style. Should those continue be part of public API? On one hand Terminal.Template is a superset of functionality of all these modules, however, they can be convenient for some quick styling when whole Template functionality is an overkill. For example, right now you can say:

Color.red "hello"

Which has same effect as:

Template.(to_string (red (text "hello")))

So the question is, should these shortcuts exist in public API or not?

/cc @erikrose @andor44

@keleshev
Copy link
Owner Author

keleshev commented Oct 6, 2015

One live example is use of Template and Color in the bundled testing framework: https://github.com/keleshev/Terminal.ml/blob/190cefaa7ddc0fa4c6f254592d8912afa567bd7f/vendor/Test.ml

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

1 participant