How does Trelent work?
Trelent analyzes the source code you upload using sophisticated Deep Learning models, and attempts to answer the 'why' instead of the 'what' for your code.
NEWDownload our free VS Code extension today!
Documentation is tedious.
Let us take care of it.
Trelent uses state of the art AI to write docstrings that explain the why of your code instead of the what.
- Python
- Java
- Javascript
- C#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def dijkstra(graph, start_vertex):
"""
The dijkstra function takes in a graph and a starting vertex. It then performs Dijkstra's algorithm to find the shortest path
from the start_vertex to all other vertices in the graph. The function returns a dictionary of distances, where each key is an
index of one of the vertices and its value is that vertex's distance from start_vertex.
:param graph: Used to Store the graph.
:param start_vertex: Used to Indicate the vertex from which we start our search.
:return: A dictionary of distances from the start vertex to all other vertices.
:doc-author: Trelent
"""
D = {v:float('inf') for v in range(graph.v)}
D[start_vertex] = 0
pq = PriorityQueue()
pq.put((0, start_vertex))
while not pq.empty():
(dist, current_vertex) = pq.get()
graph.visited.append(current_vertex)
for neighbor in range(graph.v):
if graph.edges[current_vertex][neighbor] != -1:
distance = graph.edges[current_vertex][neighbor]
if neighbor not in graph.visited:
old_cost = D[neighbor]
new_cost = D[current_vertex] + distance
if new_cost < old_cost:
pq.put((new_cost, neighbor))
D[neighbor] = new_cost
return DUp to 10% of a developer's day is spent writing documentation instead of building product.
Trelent let's developers keep developing.
Improve efficiency
By automating the generation of docstrings, you let your developers spend an extra 10% of their day doing what they do best - developing.
Reduce miscommunication
Keep communication between developers consistent, without the effort. Our docstrings dramatically improve documentation clarity.
Increase team happiness
Developers are happier when they don't have to argue over whether or not to document. Happy devs, happy life!
Increase developer efficiency by up to 10% per day
Billed monthly.
Frequently asked questions
Does Trelent store my source code?
Trelent stores your anonymized source code on our free plans to help improve our service. We do not store your source code on our paid plans. To opt out, please upgrade or discontinue use immediately. You are responsible for ensuring you own the code you submit to Trelent, or have prior permission from the owner to do so. Please see our Terms of Use and Privacy Policy for more details.
How secure is my code?
We are working towards SOC Type 2 certification so that you can be sure your data is not at risk. Your data is fully encrypted in transit and at rest.
What programming languages does Trelent support?
Currently we support C#, Java, Javascript and Python. C, C++ and VB are on our roadmap.
What kind of documentation does Trelent automate?
At the moment we write docstrings for you. Various forms of external documentation are on our roadmap.
How do I use Trelent?
Add Trelent to your favourite IDE, then click on a function you'd like to document. Then it's as easy as pressing Alt + D!