docs: Update comments #2562
docs: Update comments #2562
Conversation
| @@ -175,9 +175,9 @@ export class Tracing implements Integration { | |||
| logger.warn(`[Tracing] We added a reasonable default for you: ${defaultTracingOrigins}`); | |||
| } | |||
|
|
|||
| // Starting our inital pageload transaction | |||
| // Starting pageload transaction | |||
There was a problem hiding this comment.
Instead of fixing the typo I decided for a shorter comment. I'd be even happier to remove it completely in favor of easier to read code.
Tracing.startIdleTransaction is not bad, but makes me wonder why is it called "idle" instead of "pageload".
There was a problem hiding this comment.
Because in theory it can be used for other things besides just page load, and "idle" because it closes on idle timeout. I agree, though, that in the API review we're about to do, I'd like to reconsider the startIdleTransaction method name.
| if (global.location && global.location.href) { | ||
| // `${global.location.href}` will be used a temp transaction name | ||
| // Use `${global.location.href}` as transaction name |
There was a problem hiding this comment.
What was once a "temporary name" seems to have settled as "the name" for now.
Also not sure how useful this comment is, if the code is not clear, we could refactor to introduce a descriptive constant:
const name = global.location.href;
Tracing.startPageloadTransaction(name, ...);
|
Maybe this will not be just "update comments", but "refactor code" instead. Let's see. |
|
Going to merge this since it is just small changes to internal comments. |
Flushing out some edits I had locally for some days.