https://github.com/davidmchan/aidocsgen

A VSCode plugin for automatically generating docstrings with AI.
https://github.com/davidmchan/aidocsgen

Last synced: 12 days ago
JSON representation

A VSCode plugin for automatically generating docstrings with AI.

• Host: GitHub
• URL: https://github.com/davidmchan/aidocsgen
• Owner: DavidMChan
• License: mit
• Created: 2023-07-03T21:41:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-03T21:45:45.000Z (over 1 year ago)
• Last Synced: 2024-12-02T18:58:45.879Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 50.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# aidocsgen

Automatically generate docstrings for your file with Chat GPT!

## Features

Install the extension and run the command `aidocsgen: Generate Docstring` to generate all docstrings for your file.

## Requirements

You must have an OpenAI account, and have access to the API key. You can find your key [here](https://platform.openai.com/account/api-keys)

or you can create a new one following the tutorial [here](https://www.howtogeek.com/885918/how-to-get-an-openai-api-key/).

## Extension Settings

This extension contributes the following settings:

-   `aidocsgen.apiKey`: The API key for your OpenAI account.

-   `aidocsgen.docstringType`: A format for your docstrings. Note: This is a suggested format, and the AI doesn't always follow it.

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

## Release Notes

### 1.0.0

Initial release of aidocsgen.

---