Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aarsh2001 authored Nov 5, 2023
1 parent 8cc8a7e commit b344a04
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# DocPilot - GitHub Bot for Automatic Docstring Generation
# DocPilot - GitHub Bot for Automatic Docstring Generation
<p align="center"><img class="only-dark" width="35%" height="25%" src="https://github.com/Sam-Armstrong/DocPilot/blob/main/data/logo.png#gh-dark-mode-only"/></p>

## Overview
## 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.

## Features
## Features πŸš€

Automatic generation of docstrings for Python functions.
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.
Expand All @@ -22,7 +22,11 @@ Before using this GitHub bot, you need to have the following:
- A GitHub repository where you want to enable the bot.
- Python codebase with functions that need docstrings.

## Support and Contribution
## The Road Ahead πŸ› 
- extend this to other languages like Java, JavaScript, C++
- package this into a usable marketplace Github Action

## Support and Contribution πŸ‘¨β€πŸ³

If you encounter any issues or have suggestions for improving this GitHub bot, please open an issue in this repository. We welcome contributions from the open-source community.

Expand Down

0 comments on commit b344a04

Please sign in to comment.