Skip to content

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

Merged

Conversation

ccho-mongodb
Copy link
Contributor

@ccho-mongodb ccho-mongodb commented Aug 30, 2023

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

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?

Copy link
Collaborator

@rustagir rustagir left a 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
Copy link
Collaborator

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.
Copy link
Collaborator

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

applies throughout

Comment on lines 12 to 17
// 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.
*/
Copy link
Collaborator

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?

Chris Cho added 5 commits August 31, 2023 18:14
starts-with and ends-before

end before

rst fixes

fix
@ccho-mongodb ccho-mongodb force-pushed the DOCSP-32718-collation-snippets branch from fff87d6 to 2c35024 Compare September 1, 2023 01:53
@ccho-mongodb ccho-mongodb merged commit c66ae08 into mongodb:master Sep 5, 2023
@ccho-mongodb ccho-mongodb deleted the DOCSP-32718-collation-snippets branch September 5, 2023 21:27
ccho-mongodb pushed a commit that referenced this pull request Sep 8, 2023
)

* DOCSP-32718: add CodeWhisperer comments to collation code snippets

(cherry picked from commit c66ae08)
mongoKart pushed a commit to mongoKart/docs-node that referenced this pull request Nov 3, 2023
…ongodb#763)

* DOCSP-32718: add CodeWhisperer comments to collation code snippets
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants