Skip to content

Commit 9a665df

Browse files
committed
README fix
1 parent 47884b6 commit 9a665df

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,10 @@ This is especially useful for AI-Agents: quickly understanding large files, navi
6363

6464
## Why Use Agent Docstrings?
6565

66-
In any large-scale project, quickly understanding the contents of a file is a major challenge. Scrolling through hundreds or thousands of lines just to find a specific function or get a sense of the file's architecture is inefficient and slows down development.
66+
**Agent Docstrings** providing a scannable "Table of Contents" at the beginning of each file. This offers several key advantages:
6767

68-
**Agent Docstrings** solves this by providing an up-to-date, scannable "Table of Contents" at the beginning of each file. This offers several key advantages:
69-
70-
- **Improved Code Navigation**: Get an immediate high-level overview of any file's structure without reading its entire content. Jump directly to the code you need.
71-
- **Faster Onboarding**: AI assistants (and New developers) can familiarize themselves with the codebase much faster. The generated docstring acts as a map to the file's contents.
72-
73-
While the tool was initially inspired by the needs of AI-powered IDEs like Cursor, its utility extends to any developer or team looking to improve code maintainability and comprehension.
68+
- **Faster Onboarding**: AI Agents can familiarize themselves with the codebase much faster. The generated docstring acts as a map to the file's contents.
69+
- **Improved Code Navigation**: AI get an immediate high-level overview of any file's structure without reading its entire content. Jump directly to the code it need.
7470

7571
## Features
7672

0 commit comments

Comments
 (0)