DOCSP-36027: Shorten class headings #1229
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ============================== | ||
| MongoDB\\BulkWriteResult Class | ||
| ============================== | ||
|
|
||
| Definition | ||
| ---------- | ||
|
|
||
| .. phpclass:: MongoDB\\BulkWriteResult | ||
|
|
||
| This class contains information about an executed bulk write operation. It | ||
| encapsulates a :php:`MongoDB\\Driver\\WriteResult | ||
| <class.mongodb-driver-writeresult>` object and is returned from | ||
| :phpmethod:`MongoDB\\Collection::bulkWrite()`. | ||
|
|
||
| Methods | ||
| ------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| getDeletedCount() </reference/method/MongoDBBulkWriteResult-getDeletedCount> | ||
| getInsertedCount() </reference/method/MongoDBBulkWriteResult-getInsertedCount> | ||
| getInsertedIds() </reference/method/MongoDBBulkWriteResult-getInsertedIds> | ||
| getMatchedCount() </reference/method/MongoDBBulkWriteResult-getMatchedCount> | ||
| getModifiedCount() </reference/method/MongoDBBulkWriteResult-getModifiedCount> | ||
| getUpsertedCount() </reference/method/MongoDBBulkWriteResult-getUpsertedCount> | ||
| getUpsertedIds() </reference/method/MongoDBBulkWriteResult-getUpsertedIds> | ||
| isAcknowledged() </reference/method/MongoDBBulkWriteResult-isAcknowledged> | ||
|
|
||
| - :phpmethod:`MongoDB\\BulkWriteResult::getDeletedCount()` | ||
|
There was a problem hiding this comment. The the double backslashes are usually used for escaping but it looks like it's not necessary. On staging, I see double backslashes in all namespaces. A single backslash should be displayed.
There was a problem hiding this comment. Just to clarify: every namespace mentioned in the docs should use one instead of two backslashes? If so, I'm happy to fix the backslashes in this PR - or make a new ticket, since it seems like all the namespaces currently have two backslashes and many files would need to be modified There was a problem hiding this comment. It's always one backslash. The double backslash doesn't exist in PHP namespaces. There was a problem hiding this comment. The double backslashes were necessary for escaping syntax in RST; however, I think that was only relevant for actual headings and not cases where text is monospace-formatted. I only recently noticed that double backslashes showing up in some monospace-formatted text (as shown in @GromNaN's screenshot above), but I'm not sure if that was recently introduced by some layout changes or a very old mistake that went unnoticed until now. There was a problem hiding this comment. Tracked by @norareidy in DOCSP-36627 |
||
| - :phpmethod:`MongoDB\\BulkWriteResult::getInsertedCount()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedCount()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedIds()` | ||
| - :phpmethod:`MongoDB\\BulkWriteResult::isAcknowledged()` | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| =========================== | ||
| MongoDB\\ChangeStream Class | ||
| =========================== | ||
|
|
||
| .. versionadded:: 1.3 | ||
|
|
||
| Definition | ||
| ---------- | ||
|
|
||
| .. phpclass:: MongoDB\\ChangeStream | ||
|
|
||
| This class extends PHP's :php:`Iterator <manual/en/class.iterator.php>` | ||
| interface. An instance of this class is returned by | ||
| :phpmethod:`MongoDB\\Client::watch()`, | ||
| :phpmethod:`MongoDB\\Database::watch()`, and | ||
| :phpmethod:`MongoDB\\Collection::watch()`. | ||
|
|
||
| This class allows for iteration of events in a change stream. It also allows | ||
| iteration to automatically resume after certain errors, such as a replica set | ||
| failover. | ||
|
|
||
| Methods | ||
| ------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| current() </reference/method/MongoDBChangeStream-current> | ||
| getCursorId() </reference/method/MongoDBChangeStream-getCursorId> | ||
| getResumeToken() </reference/method/MongoDBChangeStream-getResumeToken> | ||
| key() </reference/method/MongoDBChangeStream-key> | ||
| next() </reference/method/MongoDBChangeStream-next> | ||
| rewind() </reference/method/MongoDBChangeStream-rewind> | ||
| valid() </reference/method/MongoDBChangeStream-valid> | ||
|
|
||
| - :phpmethod:`MongoDB\\ChangeStream::current()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::getCursorId()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::getResumeToken()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::key()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::next()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::rewind()` | ||
| - :phpmethod:`MongoDB\\ChangeStream::valid()` |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| =========================== | ||
| MongoDB\\DeleteResult Class | ||
| =========================== | ||
|
|
||
| Definition | ||
| ---------- | ||
|
|
||
| .. phpclass:: MongoDB\\DeleteResult | ||
|
|
||
| This class contains information about an executed delete operation. It | ||
| encapsulates a :php:`MongoDB\\Driver\\WriteResult | ||
| <class.mongodb-driver-writeresult>` object and is returned from | ||
| :phpmethod:`MongoDB\\Collection::deleteMany()` or | ||
| :phpmethod:`MongoDB\\Collection::deleteOne()`. | ||
|
|
||
| Methods | ||
| ------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| getDeletedCount() </reference/method/MongoDBDeleteResult-getDeletedCount> | ||
| isAcknowledged() </reference/method/MongoDBDeleteResult-isAcknowledged> | ||
|
|
||
| - :phpmethod:`MongoDB\\DeleteResult::getDeletedCount()` | ||
| - :phpmethod:`MongoDB\\DeleteResult::isAcknowledged()` |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.