PHPLIB-1275: Replace apiargs usage in docs with extracts#1203
Merged
jmikola merged 18 commits intomongodb:masterfrom Dec 13, 2023
Merged
PHPLIB-1275: Replace apiargs usage in docs with extracts#1203jmikola merged 18 commits intomongodb:masterfrom
jmikola merged 18 commits intomongodb:masterfrom
Conversation
This was inadvertently moved in 1043a3a
GromNaN
requested changes
Dec 11, 2023
GromNaN
approved these changes
Dec 12, 2023
Member
GromNaN
left a comment
GromNaN
left a comment
There was a problem hiding this comment.
I identified a small duplicate in createSearchIndex. After that SGTM.
alcaeus
approved these changes
Dec 13, 2023
Member
alcaeus
left a comment
alcaeus
left a comment
There was a problem hiding this comment.
Clicked through the built documentation and it looks fine. Thanks for the huge effort on this!
| function with_transaction( | ||
| MongoDB\Driver\Session $session, | ||
| callable $callback, | ||
| array $transactionOptions = [] |
Member
There was a problem hiding this comment.
Just checking to confirm that the missing trailing comma is intentional. This functionality was only added in PHP 8.0, so if we want to keep our docs PHP version consistent with the minimum library version, it would make sense to omit it.
Contributor
Author
There was a problem hiding this comment.
This was intentional in that I didn't think about it at all. I was only adding line breaks to the original content, which was on a single line.
GromNaN
approved these changes
Dec 13, 2023
jmikola
changed the title
alcaeus
added a commit
to alcaeus/mongo-php-library
that referenced
this pull request
Jan 15, 2024
* master: PHPLIB-1323 Implement `unlink` for GridFS stream wrapper (mongodb#1206) PHPLIB-1330: Sync tests for failCommand errorLabels reqs (mongodb#1214) PHPLIB-1246: Test PHP 8.3 on Evergreen (mongodb#1213) PHPLIB-1324 Implement `rename` for GridFS stream wrapper (mongodb#1207) PHPLIB-1248 Add examples on GridFS (mongodb#1196) Deprecate setting GridFS disableMD5 to false explicitly (mongodb#1205) PHPLIB-1326: Use more permissive top-level runOnRequirements (mongodb#1210) PHPLIB-1206 Add bucket alises for context resolver using GridFS StreamWrapper (mongodb#1138) Bump actions/upload-artifact from 3 to 4 (mongodb#1208) PHPLIB-1275: Replace apiargs usage in docs with extracts (mongodb#1203) Fix title formatting in Client::removeSubscriber() docs (mongodb#1204) PHPLIB-1304: Pull mongohouse image from ECR repo (mongodb#1202) Fix evergreen failures (mongodb#1200) Enable workflows to run for GitHub Merge Queue (mongodb#1199) PHPLIB-1313 Ensure the GridFS stream is saved when the script ends (mongodb#1197) PHPLIB-1309 Add addSubscriber/removeSubscriber to Client class to ease configuration (mongodb#1195) Master is now 1.18-dev
jdestefano-mongo
pushed a commit
to jdestefano-mongo/mongo-php-library
that referenced
this pull request
Jan 22, 2024
Use extracts for option includes and repeated option notes. Order options alphabetically. Split up index and command options into separate tables. * Change RST syntax for function and method params This adds a Parameters section and uses a definition list, which is more consistent with PHPC. It also allows group the options table under the options param. * Fix BulkWriteResult::getModifiedCount() return type * Fix position of type map anchor This was inadvertently moved in 1043a3a * Use basic paragraphs for Atlas Search notes * Move Atlas Search requirement note to Definition section
jdestefano-mongo
pushed a commit
to jdestefano-mongo/mongo-php-library
that referenced
this pull request
Jan 22, 2024
Use extracts for option includes and repeated option notes. Order options alphabetically. Split up index and command options into separate tables. * Change RST syntax for function and method params This adds a Parameters section and uses a definition list, which is more consistent with PHPC. It also allows group the options table under the options param. * Fix BulkWriteResult::getModifiedCount() return type * Fix position of type map anchor This was inadvertently moved in 1043a3a * Use basic paragraphs for Atlas Search notes * Move Atlas Search requirement note to Definition section
jdestefano-mongo
pushed a commit
to jdestefano-mongo/mongo-php-library
that referenced
this pull request
Jan 22, 2024
Use extracts for option includes and repeated option notes. Order options alphabetically. Split up index and command options into separate tables. * Change RST syntax for function and method params This adds a Parameters section and uses a definition list, which is more consistent with PHPC. It also allows group the options table under the options param. * Fix BulkWriteResult::getModifiedCount() return type * Fix position of type map anchor This was inadvertently moved in 1043a3a * Use basic paragraphs for Atlas Search notes * Move Atlas Search requirement note to Definition section
This was referenced Jan 22, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://jira.mongodb.org/browse/PHPLIB-1275
Note: Generated docs can be downloaded from the build artifact attached to the "Docs / Build Docs" GitHub Action, from the bottom of the "Summary" tab.