From 81dbffbab3b16b211c261631ae818cc6db6379af Mon Sep 17 00:00:00 2001 From: Nathan Gendron <nato@coderabbit.ai> Date: Tue, 10 Dec 2024 15:22:34 -0500 Subject: [PATCH 1/2] =?UTF-8?q?=E2=9C=A8=20Move=20"not=20final"=20from=20e?= =?UTF-8?q?xperiments=20to=20beta?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/early-access.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/early-access.md b/docs/early-access.md index c15a914..637d604 100644 --- a/docs/early-access.md +++ b/docs/early-access.md @@ -15,9 +15,10 @@ Beta features are ready for public testing. - The documentation may be incomplete or outdated. - The changelog may be missing. -- The feature may not be fully stable, but it should give a general idea of the final user experience. +- The feature may not be fully stable. - Edge cases may not be fully covered. -- Some parts of the feature may not be implemented. For example, the GitHub integration may be prioritized over others. +- Some parts of the feature may not be implemented. +- They may not represent the end result of the planned feature and may not have a satisfactory user experience. Whenever you use a beta feature, you may see a warning like this: @@ -32,7 +33,6 @@ Experiments are ways for CodeRabbit's development team to gather more experience - They are highly unstable and may not work at all. - There is no guarantee that they will reach the beta stage and they may be cancelled at any time without any prior notice. - They are not ready for public use and may not be sufficiently documented. -- They do not represent the end result of the planned feature and do not have a satisfactory user experience. - We are not gathering feedback for experiments - the direction they take can vary widely. Whenever you use an experiment, you may see a warning like this: From ddca997e815a24059272c0be5e842d6f30f3d3b7 Mon Sep 17 00:00:00 2001 From: Nathan Gendron <nato@coderabbit.ai> Date: Tue, 10 Dec 2024 15:24:32 -0500 Subject: [PATCH 2/2] =?UTF-8?q?=E2=9C=A8=20Move=20docstrings=20to=20beta?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/finishing-touches/docstrings.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index 050c498..587db09 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 (Experiment) +sidebar_label: Docstrings (Beta) description: Automated docstrings pull requests with CodeRabbit --- @@ -9,7 +9,7 @@ description: Automated docstrings pull requests with CodeRabbit Docstrings generation is part of the [finishing touches](/future-developments#finishing-touches) initiative. :::warning -The [docstrings](/finishing-touches/docstrings) feature is [experimental](/early-access#experiments). +The [docstrings](/finishing-touches/docstrings) feature is in [beta](/early-access#beta). ::: ## Usage @@ -40,7 +40,7 @@ The checked software forges are supported: - [x] GitHub - [ ] 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 [experimental](/early-access#experiments). +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). ## Supported languages @@ -66,7 +66,7 @@ The checked languages are supported: - [ ] 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 [experimental](/early-access#experiments). +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, there are tons of ways to declare functions. At the moment, we only support the keyword `function` at the top level.