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

[Doc] MongooseError should become simply Error #7509

Closed
JulioJu opened this issue Feb 10, 2019 · 2 comments
Closed

[Doc] MongooseError should become simply Error #7509

JulioJu opened this issue Feb 10, 2019 · 2 comments
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Milestone

Comments

@JulioJu
Copy link
Contributor

JulioJu commented Feb 10, 2019

Hi !

Actually, https://mongoosejs.com/docs/api.html#Error reference « MongooseError », but there isn't object MongooseError available in the public API, the object Alvailable in public API is Error (see ./lib/index.js) .

Therefore in the doc, maybe we must rename all MongooseError to Error. Probably, it could be done thanks a hook in https://github.com/Automattic/mongoose/blob/master/docs/source/api.js ? (not investigated more).

Furthermore, Error are not referenced in the left navigation pane. Maybe it should be added ?

Same observation for MongooseArray.

What do you think about that?

@vkarpov15
Copy link
Collaborator

Not a bad idea. We try to not clutter the left panel with too much info, but we can add mongoose errors to the API docs

@vkarpov15 vkarpov15 added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Feb 12, 2019
@vkarpov15 vkarpov15 added this to the 5.4.14 milestone Feb 12, 2019
@JulioJu
Copy link
Contributor Author

JulioJu commented Feb 13, 2019

Ok so cool ! Yes, as Error is often used ! The interest of a Validation tool is the Errors sent ;-).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Projects
None yet
Development

No branches or pull requests

2 participants