Skip to content

Commit 216baa5

Browse files
authored
[Documentation][zos_script] Add and standarize docstrings on modules/zos_script.py (#1390)
* Add and standarize docstrings on module-utils/zos_script.py * Add changelog fragment
1 parent a5d6c35 commit 216baa5

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
trivial:
2+
- zos_script - Updated docstrings to numpy style for visual aid to developers.
3+
(https://github.com/ansible-collections/ibm_zos_core/pull/1390).

plugins/modules/zos_script.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,17 @@
229229

230230

231231
def run_module():
232+
"""Initialize module.
233+
234+
Raises
235+
------
236+
fail_json
237+
Parameter verification failed.
238+
fail_json
239+
The given chdir does not exist on the system.
240+
fail_json
241+
The script terminated with an error.
242+
"""
232243
module = AnsibleModule(
233244
argument_spec=dict(
234245
chdir=dict(type='str', required=False),

0 commit comments

Comments
 (0)