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

Missing documentation on removeError and removeErrors #170

Open
MichalBryxi opened this issue May 17, 2022 · 1 comment
Open

Missing documentation on removeError and removeErrors #170

MichalBryxi opened this issue May 17, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@MichalBryxi
Copy link

While going through the READM on ember-changeset we noticed following lines:

    try {
      await this.changeset.validate((changes) => FormSchema.validate(changes));
      this.changeset.removeError(path); // << what is this method?
    } catch (e) {
      this.changeset.addError(e.path, { value: this.changeset.get(e.path), validation: e.message });
    }

We tried to look for said function in ember-changeset repo, but apart from README and test, there were no results. Then we found out that said method is actually defined on validated-changeset.

But even the README of validated-changeset does not mention this method. By looking at the other methods of the validated.ts file, it seems like validated-changeset README is missing the documentation on removeError and removeErrors?

@MichalBryxi
Copy link
Author

I'm happy to raise a PR, just making sure this is an actual issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants