nhz-io / Trelent-IntelliJ-Extension

JetBrains Plugin for Trelent

Home Page:https://plugins.jetbrains.com/plugin/18716-trelent--ai-docstrings-on-demand

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Trelent - Docs as easy as Alt + D

Ratings Size 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

Use Trelent to write documentation for your functions instantly.

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). Support for additional docstring formats include Google and Numpy styles for Python (configured in Settings -> Tools -> Trelent Settings.

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

We cannot guaruntee accuracy with docstrings we write. Please remember to always review docstrings to check for errors.

Command Reference

Write Docstring | Trelent: Write a docstring for the function or method your cursor is in.

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

Data Policy

By using Trelent you understand that we may store your data in order to improve future versions of our service. We may also share certain data with partners to provide our services (eg. server hosting). We do not sell your information to any third parties. Please contact us for more information.

About

JetBrains Plugin for Trelent

https://plugins.jetbrains.com/plugin/18716-trelent--ai-docstrings-on-demand


Languages

Language:Kotlin 100.0%