Skip to content
This repository has been archived by the owner on Sep 5, 2024. It is now read-only.

Trelent/Trelent-VSCode-Extension

Repository files navigation

Trelent - Alt + D

Ratings Size Installs Discord

Documentation sucks. Let us take care of it! Just click anywhere in your function and press Alt + D (⌘ + D on Mac).

Trelent uses AI to write documentation for your functions instantly.

Trelent writing an example docstring

Supported Languages

Trelent currently supports C#, Java, JavaScript and Python docstrings. We default to the standard formats in each language (XML, JavaDoc, JSDoc, and ReST respectively), and for Python we additionally support the Google and Numpy docstring formats. Support for additional languages is on our roadmap.

If you have any other suggestions we would love to hear from you at contact@trelent.net!

We cannot guaruntee 100% accuracy with the docstrings we write. Always review generated documentation to check for errors.

Command Reference

Trelent | Write Docstring: Write a docstring for the function or method your cursor is in. Trelent | Login: Login to your Trelent account. Trelent | Logout: Logout from your Trelent account. Trelent | Sign Up: Sign Up for a Trelent account. Trelent | Upgrade Account: Upgrade to a paid Trelent account. Trelent | Billing Portal: Go to the billing portal to manage your Trelent account.

Keybind Reference

Write Docstring | Trelent is bound to Alt + D (⌘ + D on Mac).

Menu Reference

Write Docstring | Trelent can be found in the editor context (right-click) menu when in a text editor.

Seals of Approval

"This thing is crazy! For anyone programming in Python I would recommend giving it a look." - Wyatt, Student

Disclaimer

By installing our extension, you agree to our Terms of Use and Privacy Policy. Further, you understand that we may store anonymized source code in order to improve future versions of our service, and you ensure that you have the appropriate rights of ownership for this code. We may also share certain required data with our partners to provide our services (eg. web hosting, payment processing, user accounts). We do not sell your information to any third parties. If you have any questions or concerns, please contact us by email. To host locally, please contact usto learn more about our enterprise plan.