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

.format is undocumented #5

Open
julen opened this issue Nov 26, 2015 · 0 comments
Open

.format is undocumented #5

julen opened this issue Nov 26, 2015 · 0 comments

Comments

@julen
Copy link
Contributor

julen commented Nov 26, 2015

The Plurr.format() method, which is basically the API this library is offering, lacks docs.

There are just a couple examples in the README which makes one guess the first argument is the text to be formatted, the second one being the parameters for the text. However it also accepts an object of several options.

None of this is documented, and one has to dive into the source code/demo to guess these.
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
1 participant
@julen