Skip to content

Commit

Permalink
Add deprecation note to porting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Shrews committed Jan 13, 2025
1 parent 1fa34da commit bcd1036
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/porting_guides/porting_guide_v2.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,19 @@ The above is identical to the more familiar usage of the API:
import ansible_runner
r = ansible_runner.interface.run(private_data_dir='/tmp/demo', playbook='test.yml')
Deprecations
============

The ``RunnerConfig`` object currently allows for the ``private_data_dir`` parameter to be initialized
as a positional parameter. For example:

.. code-block:: python
config = ansible_runner.RunnerConfig('/tmp/demo', playbook='test.yml')
This is the only positional argument currently allowed. A future release will require this parameter to be keyword only.

.. code-block:: python
config = ansible_runner.RunnerConfig(private_data_dir='/tmp/demo', playbook='test.yml')
2 changes: 1 addition & 1 deletion src/ansible_runner/config/runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class RunnerConfig(BaseConfig):
>>> r = Runner(config=rc)
>>> r.run()
This class inherites all the initialization parameters of the `BaseConfig` parent class, plus:
This class inherits all the initialization parameters of the `BaseConfig` parent class, plus:
:param BinaryIO _input: An optional file or file-like object for use as input in a streaming pipeline.
:param BinaryIO _output: An optional file or file-like object for use as output in a streaming pipeline.
Expand Down

0 comments on commit bcd1036

Please sign in to comment.