gptdocs README

GPTDocs is a vscode extension for generating inline documentation for functions in various coding languages. The extension utilises Open AI's Davinci Codex generative pre-trained transformer (GPT) model and api to understand user provided code and generate documentation for it.

Features

Auto documentation generation.

Development Requirements

in or

Extension Settings

This extension contributes the following settings:

• gptdocs.enable: Enable/disable this extension.

Known Issues

The whole extension currently only uses one api key. No attention has yet been paid to the scalability of this.

Release Notes

This is the first release of the extension. It is aimed at being a functional MVP.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!