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.

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

Improved Code Examples in Docs #2943

Merged
merged 2 commits into from
Nov 20, 2023
Merged

Improved Code Examples in Docs #2943

merged 2 commits into from
Nov 20, 2023

Conversation

karansohi
Copy link
Contributor

@karansohi karansohi commented Nov 18, 2023

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 "Get Started" guide to clarify the process of defining feature control points and adjusted the terminology for consistency.
    • Revised the "Per-User Rate Limiting" guide to reflect changes in request handling and rate-limiting logic.
    • Updated the SDK documentation for .NET to include changes in initialization and usage with the new C++ code examples.
    • Amended the JavaScript SDK manual to align with the updated request handling function and parameters.

@karansohi karansohi requested a review from a team as a code owner November 18, 2023 18:47
Copy link
Contributor

coderabbitai bot commented Nov 18, 2023

Walkthrough

The updates across various documentation and code samples reflect a shift in function naming from handleFlow to handleRequest, indicating a possible rebranding or refactoring of the core request handling logic. The changes also include a significant reduction in gRPC call deadlines from 20 minutes to a brisk 300 milliseconds, suggesting a focus on performance and efficiency. Additionally, there's a move to standardize certain key terms, like replacing label_key with api_key or user_id, and removing the interval value, which could imply a simplification of the rate-limiting and labeling systems.

Changes

File Path Change Summary
.../get-started/define-control-points.md
.../guides/per-user-rate-limiting.md
.../sdk/javascript/manual.md
Renamed handleFlow to handleRequest, updated deadline from 20 minutes to 300 milliseconds, and standardized label keys (label_key to api_key/user_id). Removed interval value.
.../sdk/dotnet/manual.md Changed code samples from C# to C++, demonstrating the use of the ApertureSdk builder and flow initiation.

🐇 In the brisk November air, code hops along, 🍂
🌟 Refactoring calls, deadlines now strong.
With a whisk of a tail, and a tweak here and there,
Efficiency wins, with time to spare. 🕒


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

@karansohi karansohi self-assigned this Nov 18, 2023
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 d379149 and e94d6e3.
Files selected for processing (4)
  • docs/content/get-started/define-control-points.md (2 hunks)
  • docs/content/guides/per-user-rate-limiting.md (1 hunks)
  • docs/content/sdk/dotnet/manual.md (2 hunks)
  • docs/content/sdk/javascript/manual.md (1 hunks)
Additional comments: 2
docs/content/sdk/dotnet/manual.md (1)
  • 28-34: The code snippet has been updated to use C++ syntax instead of C#. This change should be reflected in the keywords and the title of the documentation to avoid confusion. The title and keywords still reference C# and .NET, which could mislead users looking for C++ documentation.
docs/content/get-started/define-control-points.md (1)
  • 69-81: The explanation of how to create a feature control point is clear and informative. It provides a good overview of the process and the role of the StartFlow and End methods within the Aperture SDK. This section seems to be well-documented and should be helpful for users trying to implement feature control points.

docs/content/guides/per-user-rate-limiting.md Show resolved Hide resolved
docs/content/sdk/javascript/manual.md Show resolved Hide resolved
docs/content/sdk/dotnet/manual.md Show resolved Hide resolved
@hdkshingala hdkshingala merged commit 6ac3808 into main Nov 20, 2023
10 checks passed
@hdkshingala hdkshingala deleted the docs-fix-example branch November 20, 2023 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants