Skip to content

PHPLIB-284 Highlight API changes in documentation #423

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.

Sign up for GitHub

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
merged 1 commit into from
Oct 25, 2017
Merged

PHPLIB-284 Highlight API changes in documentation #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/includes/apiargs-MongoDBCollection-method-find-option.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,18 @@ interface: phpmethod
operation: ~
optional: true
---
source:
file: apiargs-common-option.yaml
ref: maxAwaitTimeMS
arg_name: option
name: maxAwaitTimeMS
type: integer
description: |
Positive integer denoting the time limit in milliseconds for the server to
block a getMore operation if no data is available. This option should only be
used if cursorType is TAILABLE_AWAIT.

.. versionadded:: 1.2
interface: phpmethod
operation: ~
optional: true
Copy link
Member

Choose a reason for hiding this comment

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

I didn't realize this was in apiargs-common-option.yaml after the previous PR. Good idea moving it back to find-option.yaml.

---
source:
file: apiargs-common-option.yaml
Expand Down
11 changes: 0 additions & 11 deletions docs/includes/apiargs-common-option.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,6 @@ operation: ~
optional: true
---
arg_name: option
name: maxAwaitTimeMS
type: integer
description: |
Positive integer denoting the time limit in milliseconds for the server to block
a getMore operation if no data is available. This option should only be used if
cursorType is TAILABLE_AWAIT.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: readConcern
type: :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
description: |
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBClient-getReadConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Client::getReadConcern()
=================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBClient-getReadPreference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Client::getReadPreference()
====================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBClient-getTypeMap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Client::getTypeMap()
=============================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBClient-getWriteConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Client::getWriteConcern()
==================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBCollection-getReadConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Collection::getReadConcern()
=====================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBCollection-getReadPreference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Collection::getReadPreference()
========================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBCollection-getTypeMap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Collection::getTypeMap()
=================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBCollection-getWriteConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Collection::getWriteConcern()
======================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBCollection-mapReduce.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Collection::mapReduce()
=================================

.. versionadded:: 1.2

Copy link
Contributor Author

@kvwalker kvwalker Oct 25, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

I added .. versionadded:: 1.2 for MongoDBCollection-mapReduce.txt here.

Copy link
Member

Choose a reason for hiding this comment

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

My mistake. I scrolled right past this.

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBDatabase-getReadConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Database::getReadConcern()
===================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBDatabase-getReadPreference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Database::getReadPreference()
======================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBDatabase-getTypeMap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Database::getTypeMap()
===============================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBDatabase-getWriteConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\Database::getWriteConcern()
====================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getChunkSizeBytes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getChunkSizeBytes()
============================================

.. versionchanged:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getChunksCollection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getChunksCollection()
==============================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getFilesCollection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getFilesCollection()
=============================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getReadConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getReadConcern()
=========================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getReadPreference.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getReadPreference()
============================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getTypeMap.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\\Bucket::getTypeMap()
=====================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/method/MongoDBGridFSBucket-getWriteConcern.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
MongoDB\\GridFS\Bucket::getWriteConcern()
=========================================

.. versionadded:: 1.2

.. default-domain:: mongodb

.. contents:: On this page
Expand Down