PHPLIB-468: Add documentation for with_transaction #680
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
alcaeus
commented
Sep 5, 2019
jmikola
requested changes
Sep 6, 2019
| -------- | ||
|
|
||
| - :php:`MongoDB\\Driver\\Session::startTransaction <mongodb-driver-session.starttransaction>` | ||
| - :php:`MongoDB\\Driver\\Session::commitTransaction <mongodb-driver-session.committransaction>` |
There was a problem hiding this comment.
Let's add:
- :manual:`Transactions: Drivers API </core/transactions-in-applications>` documentation in the MongoDB manual
- `Convenient API for Transactions <https://github.com/mongodb/specifications/blob/master/source/transactions-convenient-api/transactions-convenient-api.rst>`_ specification
Based on other docs pages, this can go after the previous PHPC links.
Also, the manual link here pertains to my later suggestion to remove the tutorial page introduced in this PR.
alcaeus
force-pushed
the
phplib-468-docs
branch
2 times, most recently
from
5da9567 to
9cda389
Compare
jmikola
reviewed
Sep 9, 2019
jmikola
reviewed
Sep 9, 2019
jmikola
reviewed
Sep 9, 2019
alcaeus
force-pushed
the
phplib-468-docs
branch
from
9cda389 to
7e0337c
Compare
jmikola
approved these changes
Sep 9, 2019
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.
https://jira.mongodb.org/browse/PHPLIB-468
I ended up adding a functions chapter after all, as I didn't want to just put the function somewhere. The tutorial is copied from the documentation examples, I feel that is most familiar. We can always add more examples if we feel that's necessary.