add WARNING to module docs - collection users should not use directly

linux-system-roles · Mar 12, 2021 · b779577 · b779577
1 parent b3529dd
commit b779577
Showing 1 changed file with 9 additions and 6 deletions.
diff --git a/library/network_connections.py b/library/network_connections.py
@@ -13,12 +13,15 @@
 short_description: module for network role to manage connection profiles
 requirements: [pygobject, dbus, NetworkManager]
 version_added: "2.0"
-description: Manage networking profiles (connections) for NetworkManager and
-  initscripts networking providers. Documentation needs to be written. Note that
-  the network_connections module tightly integrates with the network role and
-  currently it is not expected to use this module outside the role. Thus, consult
-  README.md for examples for the role.  The requirements are only for the
-  NetworkManager (nm) provider
+description:
+  - "WARNING: Do not use this module directly! It is only for role internal use."
+  - |
+    Manage networking profiles (connections) for NetworkManager and
+    initscripts networking providers. Documentation needs to be written. Note
+    that the network_connections module tightly integrates with the network
+    role and currently it is not expected to use this module outside the role.
+    Thus, consult README.md for examples for the role.  The requirements are
+    only for the NetworkManager (nm) provider.
 options: {}
 """