Docstrings supports more languages

[howonlee]

I landed a buncha more languages in the prompting in the private production repo, so that has to entail this change.

[coderabbitai]

Walkthrough

The pull request updates the documentation for docstring generation in the docs/finishing-touches/docstrings.md file. The changes primarily focus on expanding the list of supported programming languages, marking Bash, C, C#, Kotlin, Lua, Php, React TypeScript, Rust, and Swift as officially supported. Additionally, the documentation clarifies the support for JavaScript and TypeScript, specifically noting the limitations for function declarations in React versions.

Changes

File	Change Summary
docs/finishing-touches/docstrings.md	- Updated support status for multiple languages (Bash, C, C#, Kotlin, Lua, Php, React TypeScript, Rust, Swift) - Expanded note on JavaScript and TypeScript function declaration support

Possibly related PRs

• ✨ Move docstrings to beta #168: Updates to the docs/finishing-touches/docstrings.md file related to docstring feature documentation

Poem

🐰 Docstrings dancing, languages unite!
From Bash to Rust, our code shines bright
React and Swift, now in the fold
Documentation's story unfolds
A rabbit's code, now crystal clear! 📝✨

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	f6ef7c0
Status:	✅  Deploy successful!
Preview URL:	https://b78b3e8e.coderabbit-docs.pages.dev
Branch Preview URL:	https://howon-docstrings-langs.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/finishing-touches/docstrings.md (2)

68-68: Fix PHP capitalization

"Php" should be written as "PHP" to match the standard capitalization of the language name.

-- [x] Php
++ [x] PHP

---

80-80: Improve clarity and professionalism of the note

The current note uses informal language and could be more specific about supported cases.

Consider this revision:

-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.
+For JavaScript, TypeScript, and their React versions, function declarations can be written in multiple ways. Currently, only top-level functions declared using the `function` keyword are supported.

🧰 Tools

🪛 LanguageTool

[style] ~80-~80: For conciseness, consider replacing this expression with an adverb.
Context: ... are tons of ways to declare functions. At the moment, we only support the keyword function...

(AT_THE_MOMENT)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40f472f and f6ef7c0.

📒 Files selected for processing (1)

• docs/finishing-touches/docstrings.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/finishing-touches/docstrings.md

[uncategorized] ~77-~77: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... that the docstrings feature is in beta. :::note In the case of JavaScri...

(HYPHENATED_LY_ADVERB_ADJECTIVE)

---

[style] ~80-~80: For conciseness, consider replacing this expression with an adverb.
Context: ... are tons of ways to declare functions. At the moment, we only support the keyword function...

(AT_THE_MOMENT)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (1)

docs/finishing-touches/docstrings.md (1)

70-70: Consider clarifying React TypeScript listing

React TypeScript is listed separately from TypeScript. Consider adding a note to clarify the distinction between these entries, or combine them if they share the same docstring generation capabilities.

Also applies to: 75-75