adopted-ember-addons / adopted-ember-addons/validated-changeset

Missing documentation on removeError and removeErrors

Abierto
#170 1 comentario 0 reacciones 0 asignados Ver en GitHub
bug
Lenguaje dominante
TypeScript
Estrellas
38
Forks
27
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

While going through the [READM on ember-changeset](https://github.com/poteto/ember-changeset) we noticed following lines:

```js
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](https://github.com/poteto/ember-changeset/search?q=removeError), but apart from README and test, there were no results. Then we found out that said method is actually [defined on validated-changeset](https://github.com/validated-changeset/validated-changeset/blob/main/src/validated.ts#L432-L448).

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](https://github.com/validated-changeset/validated-changeset) is missing the documentation on `removeError` and `removeErrors`?

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Open src/validated.ts at lines 432-448 and the validated-changeset README; compare the existing method documentation with removeError and removeErrors. Document both methods in the README, using their definitions to describe the behavior, and verify that the examples or API descriptions are consistent.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.