Skip to content

Commit 610960b

Browse files
committed
📝 Release Docstrings
1 parent 09073a1 commit 610960b

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

docs/changelog.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

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+
822
## February 4, 2025
923

1024
### Bitbucket Cloud Support & CircleCI Pipeline Failure Detection
@@ -81,7 +95,7 @@ With this update, you can:
8195

8296
## December 12, 2024
8397

84-
### Docstrings(Beta)
98+
### Docstrings (Beta)
8599

86100
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.
87101

docs/finishing-touches/docstrings.md

+7-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Docstrings generation with CodeRabbit
3-
sidebar_label: Docstrings (Beta)
3+
sidebar_label: Docstrings
44
description: Automated docstrings pull requests with CodeRabbit
55
---
66

@@ -14,12 +14,6 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1414

1515
Docstrings generation is part of the [finishing touches](/future-development#finishing-touches).
1616

17-
:::info
18-
19-
This feature is in [beta](/early-access#beta).
20-
21-
:::
22-
2317
## Usage
2418

2519
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:
3731

3832
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.
3933

40-
We are testing this workflow internally to adjust the prompts, add more supported software forges, add more supported languages and craft 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 tested and is now available for all Pro plan users. Additionally, you can provide feedback about this feature on [Discord](https://discord.com/channels/1134356397673414807/1317286905557287022).
4135

4236
## Supported software forges
4337

4438
The checked software forges are supported:
4539

46-
- [ ] Azure DevOps
47-
- [ ] Bitbucket
40+
- [x] Azure DevOps
41+
- [ ] Bitbucket Cloud
42+
- [ ] Bitbucket Data Center
4843
- [x] GitHub
49-
- [ ] GitLab
44+
- [x] GitLab
5045

51-
The presence of an unsupported software forge 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).
46+
While Bitbucket is not officially supported, docstrings can still be generated but will be posted in a comment under the pull request. Full support for Bitbucket is planned.
5247

5348
## Supported languages
5449

@@ -60,7 +55,6 @@ The checked languages are supported:
6055
- [x] C#
6156
- [x] Elixir
6257
- [x] Go
63-
- [ ] Haskell
6458
- [x] Java
6559
- [x] JavaScript
6660
- [x] Kotlin
@@ -70,12 +64,5 @@ The checked languages are supported:
7064
- [x] React TypeScript
7165
- [x] Ruby
7266
- [x] Rust
73-
- [ ] Scala
7467
- [x] Swift
7568
- [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.
81-
:::

docs/overview/why-coderabbit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Features such as:
4141
- CodeRabbit Commands
4242
- PR summary on the fly
4343
- Visual diagrams
44-
- Docstrings (Beta)
44+
- Docstrings generation
4545
- Custom review rules
4646

4747
> All these features improve the developer experience by reducing review time, maintaining consistency, and sharing knowledge effectively across teams.

0 commit comments

Comments
 (0)