docs: clarify CMP discovery and timeout semantics in consentManagement TCF docs#6600
Open
patmmccann wants to merge 1 commit into
Open
docs: clarify CMP discovery and timeout semantics in consentManagement TCF docs#6600patmmccann wants to merge 1 commit into
patmmccann wants to merge 1 commit into
Conversation
### Motivation - The existing doc text implied `gdpr.timeout` will wait for a missing IAB CMP API/stub/locator to appear, which contradicts Prebid.js behavior and related issues; the docs needed to explicitly describe the distinction between a missing CMP interface and a slow/awaiting CMP response. ### Description - Updated the `gdpr.timeout` description to state it applies to an already-discovered CMP interface and does not poll for a missing IAB CMP API/stub/locator. - Updated the `gdpr.actionTimeout` description to clarify the action timer begins after an already-discovered CMP returns an initial/provisional response indicating user action is needed. - Rewrote Example 2 to explain the actual sequence (500ms applies only when the CMP interface is discoverable, otherwise lookup fails immediately). - Replaced a non-descriptive link text and fixed the markdownlint `MD059` issue by using a descriptive link to the AppNexus CMP repository. ### Testing - Ran `markdownlint --config .markdownlint.json dev-docs/modules/consentManagementTcf.md` and resolved the reported `MD059` error, after which linting passed. - Ran `npm install -g markdownlint-cli` and `bundle install` to satisfy tooling, and then executed `bundle exec jekyll build`, which completed successfully.
✅ Deploy Preview for prebid-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Motivation
gdpr.timeoutandgdpr.actionTimeoutso integrators understand Prebid's CMP discovery and waiting behavior.Description
gdpr.timeouttable entry to state it applies to an already-discovered CMP interface and does not wait for a missing IAB CMP API/stub/locator to appear.gdpr.actionTimeouttable entry to state the action timer begins after an already-discovered CMP returns an initial/provisional response indicating user action is needed.Testing
Codex Task