Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aarsh2001 committed Nov 5, 2023
1 parent b344a04 commit 92289f7
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@

## Overview πŸ“š

This GitHub bot is designed to streamline the process of creating and maintaining docstrings for your functions. By integrating the Claude API, this bot can automatically generate informative and well-structured docstrings for your functions. Documentation is a critical aspect of code development, and this bot aims to make it easier for developers to keep their codebase well-documented.
This GitHub bot is designed to streamline the process of writing meaningful docstrings and maintaining good clean code. By integrating the Claude API, this bot can automatically generate informative and well-structured docstrings for your functions.
Documentation is a critical aspect of code development, and this bot aims to make it easier for developers to keep their codebase well-documented and organized.

## Features πŸš€
## Features πŸ“Œ

Automatic generation of docstrings for Python functions/classes.
Utilizes the Claude API to provide detailed and meaningful docstrings.
Customizable templates and style options for generated docstrings.
Integration with GitHub actions for continuous documentation improvement.
Support for a wide range of programming paradigms and Python versions.
- Automatic generationπŸš€ of docstrings for Python functions/classes.
- Utilizes the Claude 2.0 to provide detailed and meaningful docstrings.
- Customizable templates and style options for generated docstrings.
- Uses linters like black, flake-8, autopep8 to clean code.
- Integration with GitHub CI for continuous documentation improvement.

## Getting Started

Expand Down

0 comments on commit 92289f7

Please sign in to comment.