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
Changes from 1 commit
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
Prev Previous commit
Next Next commit
📝 Reword some sentences in the supported software forges and languages
  • Loading branch information
NatoBoram committed Feb 25, 2025
commit 28547e30d395fd1c0be0bdaafe880a9dbc6a8a3d
12 changes: 8 additions & 4 deletions docs/finishing-touches/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,27 @@ 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
- [ ] Bitbucket Data Center
- [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
Expand All @@ -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.