Skip to content

Commit 327c053

Browse files
authored
✨ Move docstrings to beta (#168)
* ✨ Move "not final" from experiments to beta * ✨ Move docstrings to beta
1 parent c8c87d1 commit 327c053

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/early-access.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Beta features are ready for public testing.
1515

1616
- The documentation may be incomplete or outdated.
1717
- The changelog may be missing.
18-
- The feature may not be fully stable, but it should give a general idea of the final user experience.
18+
- The feature may not be fully stable.
1919
- Edge cases may not be fully covered.
20-
- Some parts of the feature may not be implemented. For example, the GitHub integration may be prioritized over others.
20+
- Some parts of the feature may not be implemented.
21+
- They may not represent the end result of the planned feature and may not have a satisfactory user experience.
2122

2223
Whenever you use a beta feature, you may see a warning like this:
2324

@@ -32,7 +33,6 @@ Experiments are ways for CodeRabbit's development team to gather more experience
3233
- They are highly unstable and may not work at all.
3334
- There is no guarantee that they will reach the beta stage and they may be cancelled at any time without any prior notice.
3435
- They are not ready for public use and may not be sufficiently documented.
35-
- They do not represent the end result of the planned feature and do not have a satisfactory user experience.
3636
- We are not gathering feedback for experiments - the direction they take can vary widely.
3737

3838
Whenever you use an experiment, you may see a warning like this:

docs/finishing-touches/docstrings.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Docstrings generation with CodeRabbit
3-
sidebar_label: Docstrings (Experiment)
3+
sidebar_label: Docstrings (Beta)
44
description: Automated docstrings pull requests with CodeRabbit
55
---
66

@@ -9,7 +9,7 @@ description: Automated docstrings pull requests with CodeRabbit
99
Docstrings generation is part of the [finishing touches](/future-developments#finishing-touches) initiative.
1010

1111
:::warning
12-
The [docstrings](/finishing-touches/docstrings) feature is [experimental](/early-access#experiments).
12+
The [docstrings](/finishing-touches/docstrings) feature is in [beta](/early-access#beta).
1313
:::
1414

1515
## Usage
@@ -40,7 +40,7 @@ The checked software forges are supported:
4040
- [x] GitHub
4141
- [ ] GitLab
4242

43-
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).
43+
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).
4444

4545
## Supported languages
4646

@@ -66,7 +66,7 @@ The checked languages are supported:
6666
- [ ] Swift
6767
- [x] TypeScript
6868

69-
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).
69+
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).
7070

7171
:::note
7272
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.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy