File tree 2 files changed +17
-1
lines changed
src/ansible_runner/config
2 files changed +17
-1
lines changed Original file line number Diff line number Diff line change @@ -44,3 +44,19 @@ The above is identical to the more familiar usage of the API:
44
44
45
45
import ansible_runner
46
46
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' )
Original file line number Diff line number Diff line change @@ -64,7 +64,7 @@ class RunnerConfig(BaseConfig):
64
64
>>> r = Runner(config=rc)
65
65
>>> r.run()
66
66
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:
68
68
69
69
:param BinaryIO _input: An optional file or file-like object for use as input in a streaming pipeline.
70
70
:param BinaryIO _output: An optional file or file-like object for use as output in a streaming pipeline.
You can’t perform that action at this time.
0 commit comments