Clarify difference between flag prerequisites and user property targe…#1281
Clarify difference between flag prerequisites and user property targe…#1281JeffScattini-amplitude merged 3 commits intomainfrom
Conversation
…ting Adds a new section comparing flag prerequisites with targeting based on [Experiment] user properties. Explains timing considerations, dependency tracking, and provides a table of when to use each approach. Resolves DOC-419
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| **Limitations:** | ||
|
|
||
| - **Timing issues**: The `[Experiment]` user property is set when the assignment or exposure event is ingested. If you evaluate a dependent flag before this property syncs, the user may not match the targeting rule. |
There was a problem hiding this comment.
Bug: Passive voice in timing issues explanation (Bugbot Rules)
The sentence "The [Experiment] user property is set when the assignment or exposure event is ingested" uses passive voice ("is set", "is ingested"). Active voice would be clearer, such as "Amplitude sets the [Experiment] user property when it ingests the assignment or exposure event."
|
|
||
| **Advantages:** | ||
|
|
||
| - **Evaluated together**: Prerequisites are evaluated in sequence during a single evaluation call, eliminating timing issues. |
There was a problem hiding this comment.
Bug: Passive voice in evaluated together bullet point (Bugbot Rules)
The sentence "Prerequisites are evaluated in sequence during a single evaluation call" uses passive voice ("are evaluated"). Active voice would be clearer, such as "Amplitude evaluates prerequisites in sequence during a single evaluation call."
|
|
||
| | Use case | Recommended approach | | ||
| |----------|---------------------| | ||
| | Users must be assigned to Flag-A before seeing Flag-B | Flag prerequisites | |
There was a problem hiding this comment.
Bug: Passive voice in table use cases (Bugbot Rules)
The table contains passive voice constructions: "Users must be assigned to Flag-A" (line 95) and "users who were exposed to a flag" (line 98). Consider active alternatives like "Assign users to Flag-A before they see Flag-B" and "Target users you exposed to a flag days or weeks ago."
Additional Locations (1)
05d00f6 to
1461597
Compare
1461597
|
|
||
| **Advantages:** | ||
|
|
||
| - **Evaluated together**: Amplitude evaluates prerequisites in sequence during a single evaluation call, eliminating timing issues. |
There was a problem hiding this comment.
Passive voice in bold label violates style guide
Medium Severity · Bugbot Rules
The bold label **Evaluated together** uses passive voice construction. The implied full phrase is "Prerequisites are evaluated together" which violates the Active Voice rule (CRITICAL priority). An active voice alternative like **Single evaluation** or **Evaluates in sequence** would align with the style guide.
…ting
Adds a new section comparing flag prerequisites with targeting based on [Experiment] user properties. Explains timing considerations, dependency tracking, and provides a table of when to use each approach.
Resolves DOC-419
Note
Introduces guidance contrasting flag prerequisites with targeting based on
[Experiment]user properties, and tightens evaluation step wording.[Experiment] <flag_key>properties can be used in targeting, with limitations (timing, lack of dependency visibility, potential inconsistency).Flag prerequisitesvsUser property targeting.Written by Cursor Bugbot for commit 5f69429. This will update automatically on new commits. Configure here.