From bea6979b1802c5943c3bdbac61846b4752c0a00e Mon Sep 17 00:00:00 2001 From: p-zach Date: Sat, 5 Apr 2025 15:20:19 -0400 Subject: [PATCH] Explanatory text --- doc/generating/gpt_generate.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/generating/gpt_generate.py b/doc/generating/gpt_generate.py index ef5bf7c0f..3936023e6 100644 --- a/doc/generating/gpt_generate.py +++ b/doc/generating/gpt_generate.py @@ -8,9 +8,10 @@ See LICENSE for the license information Author: Porter Zach This script generates interactive Python notebooks (.ipynb) that document GTSAM -header files. It retrieves the header file content from the GTSAM GitHub repository, -sends it to OpenAI's API for processing, and saves the generated documentation -as a Jupyter notebook. +header files. Since inserting the text of the file directly into the prompt +might be too many tokens, it retrieves the header file content from the GTSAM +GitHub repository. It then sends it to OpenAI's API for processing, and saves +the generated documentation as a Jupyter notebook. Functions: is_url_valid(url: str) -> bool: