Improve Document#populate documentation, tests #10728
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When migrating to mongoose 6 I found that the new populate syntax for
Document#populate
was missing some documentation and it was hard to migrate without having a look at the code and guessing that the syntax was the same asQuery#populate
.I'm not so familiar with documentation, but I copied the one from
Query#populate
which seems like an improvement.Maybe a "sub-page" could describe what arguments
Query#populate,
Model#populateand
Document#populate` accept in a single place instead of maintaining that in 3 different places, but I'll leave that up to you.Also added a few tests to demonstrate the arguments I was adding do work.