You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/changelog.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,20 @@ description: The latest updates and changes to CodeRabbit.
5
5
sidebar_position:13
6
6
---
7
7
8
+
##February 25, 2025
9
+
10
+
###Docstrings
11
+
12
+
```mdx-code-block
13
+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
14
+
15
+
<ProPlanNotice />
16
+
```
17
+
18
+
We're excited to announce the launch of the Docstrings feature! This functionality allows developers to generate docstrings on a pull request. By commenting`@coderabbitai generate docstrings` on any pull request, you can automatically generate docstrings for functions in the code changes.
19
+
20
+
The list of supported languages and software forges is available in[the documentation](/finishing-touches/docstrings).
21
+
8
22
##February 4, 2025
9
23
10
24
###Bitbucket Cloud Support & CircleCI Pipeline Failure Detection
@@ -81,7 +95,7 @@ With this update, you can:
81
95
82
96
##December 12, 2024
83
97
84
-
###Docstrings(Beta)
98
+
###Docstrings(Beta)
85
99
86
100
We have launched a new functionality as part of our finishing touches initiative to allow developers to generate docstrings on a pull request. This feature lets you generate docstrings by commenting`@coderabbitai generate docstrings` on any pull request. This works for both new and existing documentation. See[our documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) for details.
Copy file name to clipboardExpand all lines: docs/finishing-touches/docstrings.md
+7-20Lines changed: 7 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title:Docstrings generation with CodeRabbit
3
-
sidebar_label:Docstrings (Beta)
3
+
sidebar_label:Docstrings
4
4
description:Automated docstrings pull requests with CodeRabbit
5
5
---
6
6
@@ -14,12 +14,6 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
14
14
15
15
Docstrings generation is part of the[finishing touches](/future-development#finishing-touches).
16
16
17
-
:::info
18
-
19
-
This feature is in[beta](/early-access#beta).
20
-
21
-
:::
22
-
23
17
##Usage
24
18
25
19
Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding in-code documentation. You can request CodeRabbit to generate docstrings by typing`@coderabbitai generate docstrings` in a comment under that pull request.
@@ -37,18 +31,19 @@ Here's an example of what a pull request may look like:
37
31
38
32
CodeRabbit cannot perform further modifications to opened pull requests. From there, it's your turn to checkout the branch and improve it to satisfaction. We believe that this workflow provides a significant headstart to documenting code.
39
33
40
-
We are testing this workflow internally to adjust the prompts, add more supported software forges, add more supported languagesandcraft an excellent user experience. However, you can use this preview and enjoy a sneak peek at the future of CodeRabbit. Additionally, you can provide feedback about this feature on[Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
34
+
This feature has been rigorously testedandis now available for all Pro plan users. Additionally, you can provide feedback about this feature on[Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
41
35
42
36
##Supported software forges
43
37
44
38
The checked software forges are supported:
45
39
46
-
-[ ] Azure DevOps
47
-
-[ ] Bitbucket
40
+
-[x] Azure DevOps
41
+
-[ ] Bitbucket Cloud
42
+
-[ ] Bitbucket Data Center
48
43
-[x] GitHub
49
-
-[] GitLab
44
+
-[x] GitLab
50
45
51
-
The presence of an unsupported software forge in this list does not constitute a commitment to support it in thefuture. Remember that the docstrings featureisin[beta](/early-access#beta).
46
+
While Bitbucket is not officially supported, docstrings can still be generated but will be posted in a comment under thepull request. Full support for Bitbucketisplanned.
52
47
53
48
##Supported languages
54
49
@@ -60,7 +55,6 @@ The checked languages are supported:
60
55
-[x] C#
61
56
-[x] Elixir
62
57
-[x] Go
63
-
-[ ] Haskell
64
58
-[x] Java
65
59
-[x] JavaScript
66
60
-[x] Kotlin
@@ -70,12 +64,5 @@ The checked languages are supported:
70
64
-[x] React TypeScript
71
65
-[x] Ruby
72
66
-[x] Rust
73
-
-[ ] Scala
74
67
-[x] Swift
75
68
-[x] TypeScript
76
-
77
-
The presence of an unsupported language in this list does not constitute a commitment to support it in the future. Remember that the docstrings feature is in[beta](/early-access#beta).
78
-
79
-
:::note
80
-
In the case of JavaScript and TypeScript and the React versions of both, there are tons of ways to declare functions. At the moment, we only support the keyword`function` at the top level.