Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

docs($log): describe your change... #15592

Merged
merged 2 commits into from
Jun 30, 2017
Merged

docs($log): describe your change... #15592

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38e408f
docs($log): Add blackboxing hint
Jun 30, 2017
6e7cf24
typos + style
Narretz Jun 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/ng/log.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these links are okay. You can add both and a note that some browsers supprt blackboxing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Angular => AngularJS 🙈

*
* [Mozilla description of blackboxing](https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Black_box_a_source).
* [Chrome description of blackboxing](https://developer.chrome.com/devtools/docs/blackboxing).
*
* Note: not all browsers support blackboxing.
*
* The default is to log `debug` messages. You can use
* {@link ng.$logProvider ng.$logProvider#debugEnabled} to change this.
*
Expand Down