Skip to content

Commit 6c10082

Browse files
committed
Change RST syntax for function params
1 parent 14919b5 commit 6c10082

File tree

3 files changed

+21
-52
lines changed

3 files changed

+21
-52
lines changed

docs/reference/function/add_logger.txt

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,10 @@ Definition
2626
Parameters
2727
----------
2828

29-
This function has the following parameters:
29+
``$logger`` : Psr\\Log\\LoggerInterface
30+
A logger to register.
3031

31-
.. list-table::
32-
:header-rows: 1
33-
:widths: 20 20 80
34-
35-
* - Name
36-
- Type
37-
- Description
38-
39-
* - $logger
40-
- Psr\\Log\\LoggerInterface
41-
- A logger to register.
42-
43-
If the logger is already registered, the method will have no effect.
32+
If the logger is already registered, the method will have no effect.
4433

4534
Behavior
4635
--------

docs/reference/function/remove_logger.txt

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,10 @@ Definition
2626
Parameters
2727
----------
2828

29-
This function has the following parameters:
29+
``$logger`` : Psr\\Log\\LoggerInterface
30+
A logger to unregister.
3031

31-
.. list-table::
32-
:header-rows: 1
33-
:widths: 20 20 80
34-
35-
* - Name
36-
- Type
37-
- Description
38-
39-
* - $logger
40-
- Psr\\Log\\LoggerInterface
41-
- A logger to unregister.
42-
43-
If the logger is not registered, the method will have no effect.
32+
If the logger is not registered, the method will have no effect.
4433

4534
Errors/Exceptions
4635
-----------------

docs/reference/function/with_transaction.txt

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,27 @@ Definition
2121

2222
.. code-block:: php
2323

24-
function with_transaction(MongoDB\Driver\Session $session, callable $callback, array $transactionOptions = []): void
24+
function with_transaction(
25+
MongoDB\Driver\Session $session,
26+
callable $callback,
27+
array $transactionOptions = []
28+
): void
2529

2630
Parameters
2731
----------
2832

29-
This function has the following parameters:
33+
``$session`` : :php:`MongoDB\\Driver\\Session <mongodb-driver-session>`
34+
A client session used to execute the transaction.
3035

31-
.. list-table::
32-
:header-rows: 1
33-
:widths: 20 20 80
36+
``$callback`` : :php:`callable <language.types.callable>`
37+
A callback that will be run inside the transaction. The callback must accept a
38+
:php:`MongoDB\\Driver\\Session <mongodb-driver-session>` object as its first
39+
argument.
3440

35-
* - Name
36-
- Type
37-
- Description
38-
39-
* - $session
40-
- :php:`MongoDB\\Driver\\Session <mongodb-driver-session>`
41-
- A client session used to execute the transaction.
42-
43-
* - $callback
44-
- :php:`callable <language.types.callable>`
45-
- A callback that will be run inside the transaction. The callback must
46-
accept a :php:`MongoDB\\Driver\\Session <mongodb-driver-session>` object
47-
as first argument.
48-
49-
* - $transactionOptions
50-
- array
51-
- Transaction options, which will be passed to
52-
:php:`MongoDB\\Driver\\Session::startTransaction <mongodb-driver-session.starttransaction>`.
53-
See the extension documentation for a list of supported options.
41+
``$transactionOptions`` : array
42+
Transaction options, which will be passed to
43+
:php:`MongoDB\\Driver\\Session::startTransaction <mongodb-driver-session.starttransaction>`.
44+
See the extension documentation for a list of supported options.
5445

5546
Behavior
5647
--------

0 commit comments

Comments
 (0)