Explanatory text

release/4.3a0
p-zach 2025-04-05 15:20:19 -04:00
parent 8a0521bde9
commit bea6979b18
1 changed files with 4 additions and 3 deletions

View File

@ -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: