Repository navigation
docs: Mark the flag override API with the experimental tag - #2106
Merged
kinyoklion merged 1 commit intoOct 16, 2026
Merged
Conversation
The public override surface already said in prose that flag overrides are experimental and subject to change. The sentence now carries the @experimental tag, the TSDoc modifier that TypeDoc renders as a badge on the declaration and that editors show as a separate tag line, so the status is visible without reading the comment body. The prose stays as the tag's text. This is the form the client-side debug override API already uses.
Member
Author
|
bugbot review |
kinyoklion
marked this pull request as ready for review
October 15, 2026 21:17
Contributor
|
@launchdarkly/js-sdk-common size report |
Contributor
|
@launchdarkly/js-client-sdk-common size report |
Contributor
|
@launchdarkly/js-client-sdk size report |
joker23
approved these changes
Oct 15, 2026
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
2 participants
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.
Summary
Marks the public flag override API with the
@experimentalTSDoc tag: theoverridesproperty of the data system options,FileOverrideSourceOptions,LDOverrideSourceOptions,LDOverrideSource,LDOverrideSink, andoverrideAffectedonLDEvaluationReason. Each already said "Flag overrides are currently experimental and subject to change." in prose; that sentence is kept and now follows the tag, which is the form the client-side debug override API uses.TypeDoc renders the tag as an
Experimentalbadge on the declaration, and editors show it as a separate tag line in hover, so the status is visible without reading the comment body.Verification
typedocfor@launchdarkly/js-server-sdk-commonand@launchdarkly/js-sdk-commonrenders the badge on all six pages (LDDataSystemOptions,FileOverrideSourceOptions,LDOverrideSourceOptions,LDOverrideSource,LDOverrideSink,LDEvaluationReason) with no new warnings. Comments only; no code changes.Note
Overview
Adds the
@experimentalTSDoc tag to the public flag override surface so TypeDoc and IDE hovers show an Experimental badge, matching how other experimental APIs are documented.The tag is applied to
overrideson data system options,FileOverrideSourceOptions,LDOverrideSourceOptions,LDOverrideSource,LDOverrideSink, andoverrideAffectedonLDEvaluationReason. Existing prose (“Flag overrides are currently experimental…”) is unchanged and now follows the tag instead of sitting inline in the main comment text.Reviewed by Cursor Bugbot for commit 348c292. Bugbot is set up for automated code reviews on this repo. Configure here.