PHPLIB-1275: Replace apiargs usage in docs with extracts (#1203) #2
Conversation
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
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR TO TEST BACKPORT OF APIARGS CHANGES
Use extracts for option includes and repeated option notes. Order options alphabetically.
Split up index and command options into separate tables.
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