Skip to content

✨ Move docstrings to beta #168

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.

Sign up for GitHub

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 2 commits into from
Dec 10, 2024
Merged

✨ Move docstrings to beta #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81dbffb
✨ Move "not final" from experiments to beta
NatoBoram Dec 10, 2024
ddca997
✨ Move docstrings to beta
NatoBoram Dec 10, 2024
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
6 changes: 3 additions & 3 deletions docs/early-access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions docs/finishing-touches/docstrings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Docstrings generation with CodeRabbit
sidebar_label: Docstrings (Experiment)
sidebar_label: Docstrings (Beta)
description: Automated docstrings pull requests with CodeRabbit
---

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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.
Expand Down
Loading