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

[DOCS] Documentation does not match argument order #92

Open
SystemParadox opened this issue Oct 13, 2017 · 1 comment
Open

[DOCS] Documentation does not match argument order #92

SystemParadox opened this issue Oct 13, 2017 · 1 comment
Labels

Comments

@SystemParadox
Copy link

The readme states:

You may combine strict validation with warnings by passing true as the second argument, and warnFn as third.

However, the code is the other way around:

function normalize (data, warn, strict) {
  if(warn === true) warn = null, strict = true

Which one of these should be changed?

@remusao
Copy link

remusao commented Aug 1, 2019

I stumbled upon the same issue and it seems that both the code and type definitions in @types/normalize-package-data agree that the prototype is: normalize(data, warn, strict) or normalize(data, strict). Probably the README should be fixed?

@darcyclarke darcyclarke changed the title Documentation does not match argument order [DOCS] Documentation does not match argument order Jul 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants