Skip to content
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

Jump to bottom

Update each SDK readme with code examples #3172

Merged
merged 4 commits into from
Jan 30, 2024
Merged

Update each SDK readme with code examples #3172

merged 4 commits into from
Jan 30, 2024
+376 −15

Conversation

karansohi
Copy link
Contributor

@karansohi karansohi commented Jan 30, 2024 •
edited by coderabbitai bot
Loading

Description of change

Checklist
  • Tested in playground or other setup
  • Screenshot (Grafana) from playground added to PR for 15+ minute run
  • Documentation is changed or added
  • Tests and/or benchmarks are included
  • Breaking changes

Summary by CodeRabbit

  • Documentation
    • Updated the README.md for the C# SDK with a new "Usage" section including code examples.
    • Revised the functionality description for the aperture-go SDK to emphasize integration and flow control.
    • Added usage instructions for the Java SDK, detailing client creation and flow functionality usage.
    • Enhanced the aperture-js SDK documentation for clarity, updated links, and expanded the usage section.
    • Improved the aperture-py SDK documentation with better integration instructions and added a new flow functionality example.

@karansohi karansohi requested a review from a team as a code owner January 30, 2024 05:53
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 30, 2024 •
edited
Loading

Walkthrough

The README.md files for the SDKs of FluxNinja Aperture across various programming languages—C#, Go, Java, JavaScript, and Python—have been updated. These updates include new usage sections with code examples, revised functionality descriptions for clearer integration guidance, and enhanced flow functionality demonstrations. These changes aim to facilitate developers in integrating their .NET, Go, Java, JavaScript, and Python applications with FluxNinja Aperture more effectively.

Changes

Files Change Summaries
sdks/aperture-csharp/README.md Updated with a new "Usage" section including examples for installation, creating an Aperture client, and flow usage.
sdks/aperture-go/README.md Revised functionality description to emphasize integration with FluxNinja Aperture and added installation instructions.
sdks/aperture-java/README.md Added usage instructions including creating an Aperture client and utilizing flow functionality.
sdks/aperture-js/README.md Rephrased functionality description, updated documentation link, and expanded usage section with examples.
sdks/aperture-py/README.md Improved integration with FluxNinja Aperture, including rephrasing in the introductory comments, addition of usage instructions, and a new example demonstrating the flow functionality.

🐰✨
In the world of code where ninjas reign,
Across the lands of C#, Go, and Python's domain,
Updates bloom like flowers in spring's embrace,
Guiding devs through Aperture's maze with grace.
🌼🐇✨

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

github-actions[bot]
github-actions bot reviewed Jan 30, 2024
View reviewed changes
sdks/aperture-js/README.md Outdated Show resolved Hide resolved
sdks/aperture-js/README.md Show resolved Hide resolved
sdks/aperture-py/README.md Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jan 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f0ca2d7 and 96947ca.
Files selected for processing (5)
  • sdks/aperture-csharp/README.md (1 hunks)
  • sdks/aperture-go/README.md (1 hunks)
  • sdks/aperture-java/README.md (1 hunks)
  • sdks/aperture-js/README.md (2 hunks)
  • sdks/aperture-py/README.md (1 hunks)
Files skipped from review due to trivial changes (3)
  • sdks/aperture-go/README.md
  • sdks/aperture-java/README.md
  • sdks/aperture-js/README.md
Additional comments: 1
sdks/aperture-csharp/README.md (1)
  • 22-26: The installation command provided is clear and straightforward.

sdks/aperture-csharp/README.md Show resolved Hide resolved
sdks/aperture-csharp/README.md Show resolved Hide resolved
sdks/aperture-py/README.md Show resolved Hide resolved
sdks/aperture-py/README.md Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jan 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 96947ca and 9be5fdf.
Files selected for processing (5)
  • sdks/aperture-csharp/README.md (1 hunks)
  • sdks/aperture-go/README.md (1 hunks)
  • sdks/aperture-java/README.md (1 hunks)
  • sdks/aperture-js/README.md (2 hunks)
  • sdks/aperture-py/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • sdks/aperture-csharp/README.md
  • sdks/aperture-go/README.md
  • sdks/aperture-java/README.md
  • sdks/aperture-js/README.md
  • sdks/aperture-py/README.md

github-actions[bot]
github-actions bot reviewed Jan 30, 2024
View reviewed changes
sdks/aperture-csharp/README.md Show resolved Hide resolved
sdks/aperture-go/README.md Show resolved Hide resolved
sdks/aperture-java/README.md Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jan 30, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9be5fdf and 0c26026.
Files selected for processing (5)
  • sdks/aperture-csharp/README.md (1 hunks)
  • sdks/aperture-go/README.md (1 hunks)
  • sdks/aperture-java/README.md (1 hunks)
  • sdks/aperture-js/README.md (2 hunks)
  • sdks/aperture-py/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (5)
  • sdks/aperture-csharp/README.md
  • sdks/aperture-go/README.md
  • sdks/aperture-java/README.md
  • sdks/aperture-js/README.md
  • sdks/aperture-py/README.md

@hdkshingala hdkshingala enabled auto-merge (squash) January 30, 2024 07:19
@hdkshingala hdkshingala merged commit d4ed583 into main Jan 30, 2024
23 of 24 checks passed
@hdkshingala hdkshingala deleted the ksohi/update-sdks-readme branch January 30, 2024 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@github-actions github-actions[bot] github-actions[bot] left review comments

@hdkshingala hdkshingala hdkshingala approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@karansohi @hdkshingala