Document lookups using dwim (#80878)

lib/ansible/plugins/lookup/csvfile.py

@@ -35,6 +35,9 @@ DOCUMENTATION = r"""
       - For historical reasons, in the search keyname, quotes are treated
         literally and cannot be used around the string unless they appear
         (escaped as required) in the first column of the file you are parsing.
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative files.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/file.py

@@ -28,6 +28,9 @@ DOCUMENTATION = """
     notes:
       - if read in variable context, the file can be interpreted as YAML if the content is valid to the parser.
       - this lookup does not understand 'globbing', use the fileglob lookup instead.
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative files.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/fileglob.py

@@ -22,6 +22,9 @@ DOCUMENTATION = """
       - Matching is against local system files on the Ansible controller.
         To iterate a list of files on a remote node, use the M(ansible.builtin.find) module.
       - Returns a string list of paths joined by commas, or an empty list if no files match. For a 'true list' pass C(wantlist=True) to the lookup.
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative files.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/first_found.py

@@ -45,6 +45,9 @@ DOCUMENTATION = """
           - When C(True) and C(lookup) or C(query) specifies I(errors='ignore'), no file found will return an empty
             list and other potential errors return an empty string or empty list depending on the template call
             (in other words return values of C(lookup) v C(query)).
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative paths/files.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/ini.py

@@ -50,6 +50,9 @@ DOCUMENTATION = """
         default: False
         aliases: ['allow_none']
         version_added: '2.12'
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative files.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/lines.py

@@ -20,6 +20,7 @@ DOCUMENTATION = """
       - Like all lookups, this runs on the Ansible controller and is unaffected by other keywords such as 'become'.
         If you need to use different permissions, you must change the command or run Ansible as another user.
       - Alternatively, you can use a shell/command task that runs against localhost and registers the result.
+      - The directory of the play is used as the current working directory.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/pipe.py

@@ -24,6 +24,7 @@ DOCUMENTATION = r"""
         It is strongly recommended to pass user input or variable input via quote filter before using with pipe lookup.
         See example section for this.
         Read more about this L(Bandit B602 docs,https://bandit.readthedocs.io/en/latest/plugins/b602_subprocess_popen_with_shell_equals_true.html)
+      - The directory of the play is used as the current working directory.
 """
 
 EXAMPLES = r"""

lib/ansible/plugins/lookup/template.py

@@ -54,6 +54,9 @@ DOCUMENTATION = """
         description: The string marking the end of a comment statement.
         version_added: '2.12'
         type: str
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative templates.
 """
 
 EXAMPLES = """

lib/ansible/plugins/lookup/unvault.py

@@ -16,6 +16,9 @@ DOCUMENTATION = """
         required: True
     notes:
       - This lookup does not understand 'globbing' nor shell environment variables.
+    seealso:
+      - ref: playbook_task_paths
+        description: Search paths used for relative files.
 """
 
 EXAMPLES = """