From 953db00ab0f03e25c609c1a20d64dba8afb5d51d Mon Sep 17 00:00:00 2001
From: borealex <>
Date: Wed, 11 Jun 2025 17:52:10 +0300
Subject: [PATCH] update docs about jira.get_issue_tree_recursive

---
 docs/jira.rst | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/jira.rst b/docs/jira.rst
index c6096a39a..879528579 100644
--- a/docs/jira.rst
+++ b/docs/jira.rst
@@ -395,8 +395,13 @@ Manage issues
     # Scrap regex matches from issue description and comments:
     jira.scrap_regex_from_issue(issue_key, regex)
 
-    # Get tree representation of issue and its subtasks + inward issue links
-    jira.get_issue_tree(issue_key)
+    # Get a list that contains the tree structure of the root issue, with all subtasks and inward linked issues.
+    # (!) Function only returns child issues from the same Jira instance or from an instance to which the API key has access.
+    # :param issue_key: Jira issue key
+    # :param tree: list to store the tree structure for recursion. Do not change it.
+    # :param depth: current depth of the tree for recursion. Do not change it.
+    # :return: list of dictionaries containing the tree structure. Dictionary element contains a key (parent issue) and value (child issue).
+    jira.get_issue_tree_recursive(issue_key, tree=[], depth=0)
 
 Epic Issues
 -------------