From 92289f74d255eef38c5b169b0a1fc1978f3602d3 Mon Sep 17 00:00:00 2001 From: Aarsh Chaube <65212523+Aarsh2001@users.noreply.github.com> Date: Sun, 5 Nov 2023 12:15:01 +0000 Subject: [PATCH] Update README.md --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index da36172..5db6600 100644 --- a/README.md +++ b/README.md @@ -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