docs($log): describe your change... #15592
Conversation
src/ng/log.js
Outdated
| @@ -11,6 +11,9 @@ | |||
| * | |||
| * The main purpose of this service is to simplify debugging and troubleshooting. | |||
| * | |||
| * To reveal the location of the calls to `$log` in the JavaScript console, | |||
| * "blackbox" the Angular source in your browser. | |||
There was a problem hiding this comment.
I believe this will be confusing for people that don't know what blackboxing means (in this context). I would at least add a link to an explanation of blackboxing.
There was a problem hiding this comment.
That is a good idea. I've looked and I can't find a neutral source of sufficient standing to cite. The closest are the documentation pages from Chrome and Firefox which outline how to set blackboxing up. I guess we can just drop this PR if one of these links wouldn't suffice:
https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Black_box_a_source
https://developer.chrome.com/devtools/docs/blackboxing
There was a problem hiding this comment.
I think these links are okay. You can add both and a note that some browsers supprt blackboxing.
|
@davesidious are you still interested in making the required changes to this PR? |
Add browser-agnostic hint about blackboxing and the benefits it brings developers when using $log.
|
@Narretz I have pushed an update to the patch-5 branch. Sorry for letting this one slip through! |
src/ng/log.js
Outdated
| @@ -11,6 +11,14 @@ | |||
| * | |||
| * The main purpose of this service is to simplify debugging and troubleshooting. | |||
| * | |||
| * To reveal the location of the calls to `$log` in the JavaScript console, | |||
| * "blackbox" the Angular source in your browser. | |||
There was a problem hiding this comment.
Angular => AngularJS 🙈
|
So there's good news and bad news. 👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there. 😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request. Note to project maintainer: This is a terminal state, meaning the |
1 similar comment
|
So there's good news and bad news. 👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there. 😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request. Note to project maintainer: This is a terminal state, meaning the |
Add browser-agnostic hint about blackboxing and the benefits it brings developers when using $log. Closes #15592
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Document update
What is the current behavior? (You can also link to an open issue here)
The documentation for $log doesn't mention blackboxing, by which a developer can see the originating line of calls to $log.
What is the new behavior (if this is a feature change)?
A brief, browser-agnostic mention of blackboxing was added to the page.
Does this PR introduce a breaking change?
No.
Please check if the PR fulfills these requirements
Other information: