-
Notifications
You must be signed in to change notification settings - Fork 40
Update README.md #476
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
Update README.md #476
Conversation
WalkthroughThe README documentation was updated to revise the list of programming languages supported and planned for the code-graph tool. The update corrects the current and future language support details without altering any code or exported entities. Changes
Suggested labels
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
83-85
: Tighten grammar & style in the newly-added “Note”Minor wording tweaks will read more smoothly and keep the style consistent with the rest of the doc:
-Note: At the moment code-graph can analyze both the Java & Python source files. -Support for additional languages e.g. C, JavaScript, Go is planned to be added +Note: Currently, Code-Graph can analyze Java and Python source files only. +Support for additional languages, e.g., C, JavaScript, and Go, is planned.This:
- Drops the unnecessary “the” and ampersand.
- Adds serial commas around e.g..
- Uses “Currently” instead of “At the moment” for brevity.
- Ends each sentence with a period.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~83-~83: There might be a mistake here.
Context: ...<YOUR_SECRECT_TOKEN>" ``` Note: At the moment code-graph can analyze both the Java & ...
(QB_NEW_EN_OTHER)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...yze both the Java & Python source files. Support for additional languages e.g. C,...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~84-~84: There might be a problem here.
Context: ...on source files. Support for additional languages e.g. C, JavaScript, Go is planned to be adde...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~84-~84: There might be a problem here.
Context: ...upport for additional languages e.g. C, JavaScript, Go is planned to be added in the future. ...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~84-~84: There might be a mistake here.
Context: ...C, JavaScript, Go is planned to be added in the future. Browse to [http://localh...
(QB_NEW_EN_OTHER)
PR Type
Documentation
Description
Update supported languages from C to Java
Move C to planned future languages
Changes diagram
Changes walkthrough 📝
README.md
Update supported languages documentation
README.md
Summary by CodeRabbit