Open
Conversation
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
There was a problem hiding this comment.
Pull request overview
This PR updates the Ruby SDK documentation to accurately reflect current runtime behavior for prompt selection defaults, prompt fallback typing (including chat fallbacks), and SWR caching configuration.
Changes:
- Clarifies that omitting
version/labeluses Langfuse API default selection (not a guaranteedproductionlabel). - Updates
get_promptdocs to reflectfallbackcan beString(text) orArray<Hash>(chat). - Adjusts caching guidance to remove misleading “auto-set” wording around
cache_stale_ttl.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/PROMPTS.md | Updates best-practice guidance to recommend explicit production labels and treats implicit selection as API-defined. |
| docs/CACHING.md | Removes incorrect implication that cache_stale_ttl is auto-set; frames it as an explicit, common default. |
| docs/API_REFERENCE.md | Corrects get_prompt parameter typing/docs and example wording around API default selection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DRWhyChecklistCloses #
Summary
Fixes Addressed
docs/CACHING.md: removed incorrect "auto-set" wording forcache_stale_ttl.docs/API_REFERENCE.md: correctedget_promptfallbacktype to include chat fallback arrays.docs/PROMPTS.md: clarified unlabeled selection as API-defined and explicit-label best practice.Validation Checklist
npx langfuse-cli api __schema)npx langfuse-cli api prompts get --help)bundle exec rspec(blocked locally: Bundler executable mismatch)bundle exec rubocop(blocked locally: Bundler executable mismatch)