add note about arguments in shebang in modules #1718
Conversation
ansible-documentation-bot
bot
added
the
new_contributor
|
Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda. |
|
Hi @mabezi ! when you accept the suggested edits above, you'll then need to rebase this PR due to a change in the underling CI tests. Thanks! |
mabezi
force-pushed
the
add_shebang_notice
branch
from
cd49ce4
to
4001811
Compare
|
Thanks for the docs contribution @mabezi ! |
oraNod
added
backport-2.15
Backport to stable-2.17: 💚 backport PR created✅ Backport PR branch: Backported as #1773 🤖 @patchback |
Backport to stable-2.15: 💚 backport PR created✅ Backport PR branch: Backported as #1774 🤖 @patchback |
Backport to stable-2.16: 💚 backport PR created✅ Backport PR branch: Backported as #1775 🤖 @patchback |
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624)
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624)
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624)
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624) Co-authored-by: mabezi <[email protected]>
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624) Co-authored-by: mabezi <[email protected]>
* add note about arguments in shebang in modules * update note about arguments in shebang in modules * move notes about shebang in one warning (cherry picked from commit 9076624) Co-authored-by: mabezi <[email protected]>
In ansible/ansible#83603 the result of the discussion was that it is neither wanted nor supported to use arguments in the shebang.
Obviously, this feature is not a matter of common knowledge. I'm far from the only one who didn't know that. (e.g. VMware's NSX-T Ansible Modules or even the test-playbook from ansible itself)
imho this is also due to ambiguous documentation.
With this PR, I would like to make the documentation a little clearer. I'm always open to suggestions for improvement.