Skip to content
This repository has been archived by the owner on Oct 10, 2018. It is now read-only.

Documentation incorrect for getErrorMessage #54

Open
jwalton opened this issue May 6, 2017 · 1 comment
Open

Documentation incorrect for getErrorMessage #54

jwalton opened this issue May 6, 2017 · 1 comment

Comments

@jwalton
Copy link

jwalton commented May 6, 2017

Docs say:

This is the method that apiCheck uses to get the message it throws or console.warns. If you don't like it, feel free to make a better one by simply: apiCheck.getErrorMessage = function(api, args, output) {/* return message */}

But, it appears that getErrorMessage() actually is a function(api, args, messages, output).

@kentcdodds
Copy link
Owner

Hi @jwalton,
I'm not really maintaining this library anymore, but if you'd like to make a PR to fix the docs I'd be happy to merge it. Thanks.

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

No branches or pull requests

2 participants