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

documentation on the options object #1702

Closed
nikmartin opened this issue Sep 21, 2013 · 4 comments
Closed

documentation on the options object #1702

nikmartin opened this issue Sep 21, 2013 · 4 comments
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Milestone

Comments

@nikmartin
Copy link
Contributor

There are references throughout the mongoose docs about this nebulous 'otions' object that can be passed to queries, populate, etc. All the available options for the options object are not documented anywhere that I can tell. For instance, I think it is possible to exclude fields by passing '-fieldname' as an option, but I cannot find it documented anywhere. I have even gone to the MongoDB site. If I could find the definitive source for options, I'd be glad to fork the docs and submit a pull request, since I know others are also looking for this info.

@aheckmann
Copy link
Collaborator

@aheckmann
Copy link
Collaborator

@nikmartin
Copy link
Contributor Author

Thanks for that. I think the problem may be the description describes a
path, but path is not defined. It also I'd sorry of implicit add am option,
and never really defined. Let me spend some time with it and I'll be glad
to contribute. I have contributed before, so I know the process of jade
templates, etc. I'll also look at population, as it looked like it could
have used some additional detail as well. I'd like to make it easier for
people new to nosql dB's like myself, as node.is is attracting a lot of new
developers, and irc, so, and the group are all a bit sparse on new user
type docs.

Nik
On Sep 21, 2013 7:06 PM, "Aaron Heckmann" notifications@github.com wrote:

http://mongoosejs.com/docs/api.html#query_Query-select

But feel free to improve the docs however you see fit!
https://github.com/LearnBoost/mongoose/blob/master/CONTRIBUTING.md#documentation


Reply to this email directly or view it on GitHubhttps://github.com//issues/1702#issuecomment-24873185
.

@aheckmann
Copy link
Collaborator

Excellent. That would be wonderful.

@vkarpov15 vkarpov15 added this to the 4.13.5 milestone Nov 23, 2017
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

3 participants