From 610960b344184b46a958ea265182f012a809b1cd Mon Sep 17 00:00:00 2001 From: Nathan Gendron Date: Tue, 25 Feb 2025 13:57:45 -0500 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=93=9D=20Release=20Docstrings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/changelog.md | 16 +++++++++++++++- docs/finishing-touches/docstrings.md | 27 +++++++-------------------- docs/overview/why-coderabbit.md | 2 +- 3 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 985aa226..96c78f25 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,20 @@ 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'; + + +``` + +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). + ## February 4, 2025 ### Bitbucket Cloud Support & CircleCI Pipeline Failure Detection @@ -81,7 +95,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. diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index 39defef5..b37b60ef 100644 --- a/docs/finishing-touches/docstrings.md +++ b/docs/finishing-touches/docstrings.md @@ -1,6 +1,6 @@ --- title: Docstrings generation with CodeRabbit -sidebar_label: Docstrings (Beta) +sidebar_label: Docstrings description: Automated docstrings pull requests with CodeRabbit --- @@ -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. @@ -37,18 +31,19 @@ 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: -- [ ] 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 but will be posted in a comment under the pull request. Full support for Bitbucket is planned. ## Supported languages @@ -60,7 +55,6 @@ The checked languages are supported: - [x] C# - [x] Elixir - [x] Go -- [ ] Haskell - [x] Java - [x] JavaScript - [x] Kotlin @@ -70,12 +64,5 @@ The checked languages are supported: - [x] React TypeScript - [x] Ruby - [x] Rust -- [ ] Scala - [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. -::: diff --git a/docs/overview/why-coderabbit.md b/docs/overview/why-coderabbit.md index 66053f72..cbdfc5f6 100644 --- a/docs/overview/why-coderabbit.md +++ b/docs/overview/why-coderabbit.md @@ -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. From 28547e30d395fd1c0be0bdaafe880a9dbc6a8a3d Mon Sep 17 00:00:00 2001 From: Nathan Gendron Date: Tue, 25 Feb 2025 15:10:03 -0500 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=93=9D=20Reword=20some=20sentences=20?= =?UTF-8?q?in=20the=20supported=20software=20forges=20and=20languages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/finishing-touches/docstrings.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index b37b60ef..4de183b5 100644 --- a/docs/finishing-touches/docstrings.md +++ b/docs/finishing-touches/docstrings.md @@ -35,7 +35,7 @@ This feature has been rigorously tested and is now available for all Pro plan us ## Supported software forges -The checked software forges are supported: +These software forges are supported: - [x] Azure DevOps - [ ] Bitbucket Cloud @@ -43,18 +43,19 @@ The checked software forges are supported: - [x] GitHub - [x] GitLab -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. +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 - [x] Java - [x] JavaScript - [x] Kotlin @@ -64,5 +65,8 @@ The checked languages are supported: - [x] React TypeScript - [x] Ruby - [x] Rust +- [ ] Scala - [x] Swift - [x] TypeScript + +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. From 11fa6b46aa260494d3b9729bca407f3af77ca593 Mon Sep 17 00:00:00 2001 From: Nathan Gendron Date: Tue, 25 Feb 2025 17:32:42 -0500 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=93=9D=20Add=20Azure=20DevOps=20pipel?= =?UTF-8?q?ine=20failure=20detection=20announcement=20to=20changelog?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/changelog.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 96c78f25..e200f30b 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -19,6 +19,10 @@ We're excited to announce the launch of the Docstrings feature! This functionali 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