search

tenxstudio / devtale

Document your code repositories with LLMs
MIT License
23 stars 7 forks source link

Remove file-level devtale docstring label from main README #55

Closed betogaona7 closed 1 year ago

betogaona7 commented 1 year ago

The docstrings are currently added in the JSON file generated per file, we send the item "file-docstring" as the description of the file for the folder-level logic which includes the @DEVTALE-GENERATED label, so we should drop the label before sending it to the folder-level logic to avoid its addition on README files.

Keep it only for fusing the docstring into code, then drop it

Incorrect output example: 

#### ./
This folder contains a script called `cli.py` which enables users to quickly generate documentation for a repository, folder, or file using an OpenAI model. It provides options to explore subfolders, add docstrings to the code file, specify the output path, and mock answers to reduce GPT calls. The script simplifies and automates the process of creating documentation.

**Files list:**

- **cli.py**: @DEVTALE-GENERATED:
This script enables users to quickly generate documentation for a repository, folder, or file using an OpenAI model. It provides options to explore subfolders, add docstrings to the code file, specify the output path, and mock answers to reduce GPT calls. The script simplifies and automates the process of creating documentation.