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.

Sign up for GitHub

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

Jump to bottom

Document all exports #56

Closed
saadq opened this issue Mar 15, 2018 · 1 comment
Closed

Document all exports #56

saadq opened this issue Mar 15, 2018 · 1 comment

Comments

@saadq
Copy link

saadq commented Mar 15, 2018

Hey, great work with this package.

I had been planning on writing some Flow type definitions, but I noticed that some exports aren't documented in the README. You already have an open issue for Indent, but there's also StringComponent, build, and diff. It would be great if these could be documented just to know whether I should include them in the type definitions or not.

Thanks again for ink!
@vadimdemedes
Copy link
Owner

StringComponent, build and diff are private (internal) functions, they shouldn't be used by users of Ink.

P.S. Glad you like it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@vadimdemedes @saadq