Skip to content

DOCSP-44644: db/coll access methods #189

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

rustagir
Copy link
Collaborator

@rustagir rustagir commented Feb 4, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-44644
Staging:

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?

Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for docs-php-library ready!

Name Link
🔨 Latest commit 91b9614
🔍 Latest deploy log https://app.netlify.com/sites/docs-php-library/deploys/67a240636a45d600080098e9
😎 Deploy Preview https://deploy-preview-189--docs-php-library.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rustagir rustagir changed the base branch from master to v2.0 February 4, 2025 15:49
@rustagir rustagir changed the base branch from v2.0 to master February 4, 2025 15:50
Comment on lines 32 to 36
``$databaseName`` : string
The name of the database containing the collection to select.

``$collectionName`` : string
The name of the collection to select.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe just semantics:

Suggested change
``$databaseName`` : string
The name of the database containing the collection to select.
``$collectionName`` : string
The name of the collection to select.
``$databaseName`` : string
The name of the database containing the collection to get.
``$collectionName`` : string
The name of the collection to get.

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'll just change this wording to "access". I think get is too general and might not accurately describe what is happening, despite the methods' names

Comment on lines 44 to 62
* - readConcern
- :php:`MongoDB\Driver\ReadConcern <class.mongodb-driver-readconcern>`
- The default read concern to use for database operations. Defaults to
the client's read concern.

* - readPreference
- :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
- The default read preference to use for database operations. Defaults to
the client's read preference.

* - typeMap
- array
- The default type map to use for database operations. Defaults to the
client's type map.

* - writeConcern
- :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
- The default write concern to use for database operations. Defaults to
the client's write concern.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This indentation is causing the top line to be bolded. This should be updated on the selectDatabase() page as well.

Suggested change
* - readConcern
- :php:`MongoDB\Driver\ReadConcern <class.mongodb-driver-readconcern>`
- The default read concern to use for database operations. Defaults to
the client's read concern.
* - readPreference
- :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
- The default read preference to use for database operations. Defaults to
the client's read preference.
* - typeMap
- array
- The default type map to use for database operations. Defaults to the
client's type map.
* - writeConcern
- :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
- The default write concern to use for database operations. Defaults to
the client's write concern.
* - readConcern
- :php:`MongoDB\Driver\ReadConcern <class.mongodb-driver-readconcern>`
- The default read concern to use for database operations. Defaults to
the client's read concern.
* - readPreference
- :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
- The default read preference to use for database operations. Defaults to
the client's read preference.
* - typeMap
- array
- The default type map to use for database operations. Defaults to the
client's type map.
* - writeConcern
- :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
- The default write concern to use for database operations. Defaults to
the client's write concern.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this is a vscode issue, just resolved

@rustagir rustagir requested a review from rachel-mack February 4, 2025 16:21
Copy link
Collaborator

@rachel-mack rachel-mack left a comment

Choose a reason for hiding this comment

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

one tweak:

@rustagir rustagir merged commit fd77a74 into mongodb:master Feb 4, 2025
5 of 7 checks passed
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