-
Notifications
You must be signed in to change notification settings - Fork 52
DOCSP-32718: add CodeWhisperer comments to collation code snippets #763
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
DOCSP-32718: add CodeWhisperer comments to collation code snippets #763
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small things, but not blocking
@@ -1,3 +1,4 @@ | |||
// Retrieve the total matching names, grouped by the first_name field and sorted by using the German phonebook collation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: since this comment is causing horizontal scroll, make it a multi line comment. Or, could it be more beneficial to comment before the each stage + the collation line?
@@ -1,15 +1,20 @@ | |||
// start create collection with collation | |||
// Create the collection with a collation | |||
// Create the "souvenirs" collection and specify the French Canadian collation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: no periods for single line comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
applies throughout
// no collation specified | ||
/* | ||
Retrieve documents that match the "year" value "1980" | ||
in descending order of the value of the "title" field | ||
that does not use the collation index. | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: For this code comment and the next, is there a way to combine the code comments content so these aren't stacked?
fff87d6
to
2c35024
Compare
) * DOCSP-32718: add CodeWhisperer comments to collation code snippets (cherry picked from commit c66ae08)
…ongodb#763) * DOCSP-32718: add CodeWhisperer comments to collation code snippets
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-32718
Staging -
https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-32718-collation-snippets/fundamentals/collations/
Self-Review Checklist