Coder Social home page Coder Social logo

awekrx / autodoc-chatgpt Goto Github PK

View Code? Open in Web Editor NEW
388.0 5.0 31.0 38 KB

AutoDoc-ChatGPT is a Python script that leverages the power of ChatGPT model to automatically generate documentation for any programming language. With AutoDoc-ChatGPT, you can easily generate comprehensive documentation for your codebase.

License: MIT License

Python 86.45% TypeScript 11.75% JavaScript 1.80%
ai auto-comments auto-documentation automation chatgpt chatgpt-api openai automated-documentation cli-documentation comments

autodoc-chatgpt's Introduction

autodoc-chatgpt's People

Contributors

awekrx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

autodoc-chatgpt's Issues

Go Support?

Hey mate,

Great work on this repo, I've been looking for something like this! Is there any chance you're going to implement support for Go anytime soon? That'd be super useful for me and I'm sure many others. Thanks in advance.

Feedback into ChatGPT based on Pre-commit and pytest?

Thank you for creating such a wonderful project! I planned to create a simular application, that includes the generation of tests.

Observations

  • After interacting with ChatGPT for a while, I noticed it would often require some encouragements of me to create a complete function/response. (E.g. it would only return half of the expected function, and after asking it 5 times, "please finish it", it would (eventually)).
  • I noticed its solutions were often not compliant with (strict) pre-commit requirements (e.g.). However, after it was given the feedback of the pre-commit violations, e.g. line-length violations by python black, or missing type-hints, it would often correct itself.

Question

Hence, I would like to ask:

would you be willing to enhance this repository to facilitate automatic feedback into chatgpt based on pre-commit output?

(Example output:)
image

For completeness, a detailed suggestion on how such a feedback could be realised can be found in here, and perhaps you have different ideas :)

Ps. If you have any questions on pre-commit or otherwise, feel free to reach out!

Unable to parse passwords with special chars

File "C:\Users\primetime43\AppData\Local\Programs\Python\Python311\Lib\configparser.py", line 443, in _interpolate_some
raise InterpolationSyntaxError(
configparser.InterpolationSyntaxError: '%' must be followed by '%' or '(', found: '%94s^6'

I have the config file all filed out with email, pass, and the token, but gives this error when trying to run due to the password having certain characters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.