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

docsp-27681 - move example classes #150

Merged
merged 5 commits into from
Dec 20, 2023

Conversation

mongoKart
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-27681
Staging - https://preview-mongodbmongokart.gatsbyjs.io/csharp/docsp-27681-move-sample-classes/usage-examples/

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?
  • Are the facets and meta keywords accurate?

Comment on lines 74 to 75
The usage examples in this section use the following ``Restaurant``, ``Address``, and
``GradeEntry`` classes as models:
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: in this introduction, mention the db/collection as well, to provide some context. Perhaps something like:

Suggested change
The usage examples in this section use the following ``Restaurant``, ``Address``, and
``GradeEntry`` classes as models:
The usage examples in this section demonstrate how to perform operatons on documents in the
``restaurants`` collection. The examples use the following ``Restaurant``, ``Address``, and
``GradeEntry`` classes to model the data in this collection:

Or, you can add this information to the first sentence earlier in this file that says "These examples use the
sample datasets provided by Atlas." because this suggests that the examples use more than one collection, but its seems like they all use the restaurants collection.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think the first option still suggests that the restaurants collection is part of the Atlas sample datasets, so I went with that

Comment on lines 18 to 19
Example
-------
Copy link
Collaborator

Choose a reason for hiding this comment

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

I: I think you should consider leaving this heading in all of the usage examples, since removing it makes it so that the tree navigation on some of the pages starts with "Expected Result" like here and here

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good thought

@mongoKart mongoKart requested a review from rustagir December 20, 2023 15:56
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.

approving but make sure to fix the missing heading in updatemany.txt

source/usage-examples/deleteOne.txt Outdated Show resolved Hide resolved
source/usage-examples/updateMany.txt Show resolved Hide resolved
@mongoKart mongoKart merged commit 9ec1bae into mongodb:master Dec 20, 2023
2 checks passed
@mongoKart mongoKart deleted the docsp-27681-move-sample-classes branch December 20, 2023 16:49
mongoKart added a commit that referenced this pull request Dec 20, 2023
mongoKart added a commit that referenced this pull request Dec 20, 2023
mongoKart added a commit that referenced this pull request Dec 20, 2023
mongoKart added a commit that referenced this pull request Dec 20, 2023
mongoKart added a commit that referenced this pull request Dec 20, 2023
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