Skip to content

Commit bcb01cb

Browse files
Add guidance for handling large outputs from list_directory_tree in documentation
1 parent 5af0ef6 commit bcb01cb

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

bp-examples/scripts/document-code-cycles.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@
7979
<runcode>
8080
print(list_directory_tree(folder_path = '"""+folder_name+"""', add_function_signatures = True))
8181
</runcode>
82+
In large projects, list_directory_tree result is too big to fit in a single runcode call. In these cases, you will save the result into a temporary file and then read the result bit by bit.
8283
You will first pick a portion of the documentation that you consider that is either missing, disrespecting these instructions or could be improved.
8384
Then, edit the markdown documentation for the source code found in the """+folder_name+""" folder.
8485
You may use small code snippets where appropriate to illustrate key points.

0 commit comments

Comments
 (0)