Skip to content

📝 Release Docstrings #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@ description: The latest updates and changes to CodeRabbit.
sidebar_position: 13
---

## February 25, 2025

### Docstrings

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

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.

The list of supported languages and software forges is available in [the documentation](/finishing-touches/docstrings).

### Azure DevOps Pipeline Failure Detection

We're excited to announce that our pipeline error detection capabilities now extend to Azure DevOps! Just like with GitHub Actions, GitLab CI/CD, and CircleCI, you can now automatically detect and fix pipeline failures in your Azure DevOps pipelines.

## February 4, 2025

### Bitbucket Cloud Support & CircleCI Pipeline Failure Detection
Expand Down Expand Up @@ -81,7 +99,7 @@ With this update, you can:

## December 12, 2024

### Docstrings(Beta)
### Docstrings (Beta)

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.

Expand Down
31 changes: 11 additions & 20 deletions docs/finishing-touches/docstrings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Docstrings generation with CodeRabbit
sidebar_label: Docstrings (Beta)
sidebar_label: Docstrings
description: Automated docstrings pull requests with CodeRabbit
---

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

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

:::info

This feature is in [beta](/early-access#beta).

:::

## Usage

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.
Expand All @@ -37,27 +31,28 @@ Here's an example of what a pull request may look like:

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.

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).
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).

## Supported software forges

The checked software forges are supported:
These software forges are supported:

- [ ] Azure DevOps
- [ ] Bitbucket
- [x] Azure DevOps
- [ ] Bitbucket Cloud
- [ ] Bitbucket Data Center
- [x] GitHub
- [ ] GitLab
- [x] GitLab

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).
While Bitbucket is not officially supported, docstrings can still be generated. However, they will be posted in a comment under the pull request. Full support for Bitbucket is planned.

## Supported languages

The checked languages are supported:
These languages are supported:

- [x] Bash
- [x] C
- [x] C++
- [x] C#
- [x] C++
- [x] Elixir
- [x] Go
- [ ] Haskell
Expand All @@ -74,8 +69,4 @@ The checked languages are supported:
- [x] Swift
- [x] TypeScript

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).

:::note
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.
:::
CodeRabbit uses `ast-grep` to parse the code. If you want a new language to be supported, please look into [Add New Language to ast-grep](https://ast-grep.github.io/contributing/add-lang.html#add-new-language-to-ast-grep) first.
2 changes: 1 addition & 1 deletion docs/overview/why-coderabbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Features such as:
- CodeRabbit Commands
- PR summary on the fly
- Visual diagrams
- Docstrings (Beta)
- Docstrings generation
- Custom review rules

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