Skip to content

Commit bcd1036

Browse files
committed
Add deprecation note to porting guide
1 parent 1fa34da commit bcd1036

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

docs/porting_guides/porting_guide_v2.5.rst

+16
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,19 @@ The above is identical to the more familiar usage of the API:
4444
4545
import ansible_runner
4646
r = ansible_runner.interface.run(private_data_dir='/tmp/demo', playbook='test.yml')
47+
48+
Deprecations
49+
============
50+
51+
The ``RunnerConfig`` object currently allows for the ``private_data_dir`` parameter to be initialized
52+
as a positional parameter. For example:
53+
54+
.. code-block:: python
55+
56+
config = ansible_runner.RunnerConfig('/tmp/demo', playbook='test.yml')
57+
58+
This is the only positional argument currently allowed. A future release will require this parameter to be keyword only.
59+
60+
.. code-block:: python
61+
62+
config = ansible_runner.RunnerConfig(private_data_dir='/tmp/demo', playbook='test.yml')

src/ansible_runner/config/runner.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class RunnerConfig(BaseConfig):
6464
>>> r = Runner(config=rc)
6565
>>> r.run()
6666
67-
This class inherites all the initialization parameters of the `BaseConfig` parent class, plus:
67+
This class inherits all the initialization parameters of the `BaseConfig` parent class, plus:
6868
6969
:param BinaryIO _input: An optional file or file-like object for use as input in a streaming pipeline.
7070
:param BinaryIO _output: An optional file or file-like object for use as output in a streaming pipeline.

0 commit comments

Comments
 (0)