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.

Sign up for GitHub

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

Jump to bottom

Model JSDOC Touch-Up #12086

Merged
merged 21 commits into from
Jul 16, 2022
Merged

Model JSDOC Touch-Up #12086

merged 21 commits into from
Jul 16, 2022

Conversation

hasezoey
Copy link
Collaborator

Summary

This PR Improves the JSDOC of lib/model.js.

Changes include:

  • fix missing types from @param tags
  • changes some examples from callback-style to await-style
  • moves options to @param tags
  • change some things to make the style consistent
  • renames parameter o to opts for mapReduce to be more clear what that parameter does

There are some added TODO's, because i was not sure what type they were

hasezoey added 17 commits July 11, 2022 13:22
@hasezoey
style(model): fix "Model.undefined" in the documentation for "Model.e…
755511f 
…vents"
@hasezoey
style(model): move jsdoc for "Model.prototype.increment" to the publi…
c04be0a 
…c place (for docs)
@hasezoey
style(model): rename option "o" to "opts" for "Model.mapReduce"
93f3d8b 
This is to make it more obvious to what this parameter does
@hasezoey
style(model): move option description to jsdoc tags for "Model.mapRed…
3090068 
…uce"
@hasezoey
style(model): remove duplicated parameter for "Model.update"
60d9812
@hasezoey
style(model): update alternative example for "Model.findOneAndRemove"…
4873092 
… to use await
@hasezoey
style(model): update alternative example for "Model.findOneAndDelete"…
0e0598a 
… to use await
@hasezoey
style(model): update alternative example for "Model.findByIdAndUpdate…
00ff60a 
…" to use await
@hasezoey
style(model): move option description to jsdoc tags for "Model.findOn…
1b4680e 
…eAndUpdate"
@hasezoey
style(model): move option description to jsdoc tags for "Model.findBy…
ca5d2e4 
…IdAndUpdate"
@hasezoey
style(model): move option description to jsdoc tags for "Model.findOn…
429e7f9 
…eAndReplace"
@hasezoey
style(model): move option description to jsdoc tags for "Model.findOn…
9e60262 
…eAndRemove"
@hasezoey
style(model): move option description to jsdoc tags for "Model.findBy…
caf0e59 
…IdAndRemove"
@hasezoey
style(model): change some jsdoc to be consistent
b63b289
@hasezoey
style(model): fix missing type for "Model" "fields"
82d964e
@hasezoey
style(model): update example for "Model.prototype.increment" to use a…
fc4ada4 
…wait
@hasezoey
style(model): update example for "Model.prototype.remove" to use await
3dd7b52
hasezoey
hasezoey commented Jul 11, 2022
View reviewed changes
Copy link
Collaborator Author

@hasezoey hasezoey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO notes

AbdelrahmanHafez
AbdelrahmanHafez reviewed Jul 11, 2022
View reviewed changes
vkarpov15
vkarpov15 requested changes Jul 15, 2022
View reviewed changes
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just had several small suggestions

@hasezoey hasezoey requested a review from vkarpov15 July 15, 2022 09:56
vkarpov15
vkarpov15 approved these changes Jul 16, 2022
View reviewed changes
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vkarpov15 vkarpov15 added this to the 6.4.5 milestone Jul 16, 2022
@vkarpov15 vkarpov15 merged commit 1306d00 into Automattic:master Jul 16, 2022
@hasezoey hasezoey deleted the modelJSDOCTouchup branch July 17, 2022 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AbdelrahmanHafez AbdelrahmanHafez

@vkarpov15 vkarpov15

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
6.4.5
Development

Successfully merging this pull request may close these issues.
3 participants
@hasezoey @vkarpov15 @AbdelrahmanHafez