add description to RD module #3464
Merged
Conversation
This file contains 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
bretg
requested changes
Jan 19, 2019
There was a problem hiding this comment.
Would like to see a brief description on top of each function. It's not obvious to me what is the difference between an "origin", a "canonicalUrl", and "PubUrl" in the function names getAncestorOrigins, getCanonicalUrl, and getPubUrlStack
The terms used in the description of the refererInfo object also refer to "top url" (is that the canonical?) If "origin" is just a url, and canonical url is just the topmost url, would be clearer to use those terms.
* @property {string} referer detected top url
* @property {boolean} reachedTop whether prebid was able to walk upto top window or not
* @property {number} numIframes number of iframes
* @property {string} stack comma separated urls of all origins
|
@bretg I pushed some more comments to address your feedback. One of the contributor requested to add canonical url in this module. #3221 |
bretg
approved these changes
Jan 28, 2019
pedrolopezmrf
pushed a commit
to Marfeel/Prebid.js
that referenced
this pull request
Mar 18, 2019
* add description to RD module * adding some more comments to private functions
jacekburys-quantcast
pushed a commit
to jacekburys-quantcast/Prebid.js
that referenced
this pull request
May 15, 2019
* add description to RD module * adding some more comments to private functions
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.
Type of change
Description of change
Just a comment explaining what the module does.