diff options
| author | Peter Bacon Darwin | 2014-02-07 20:40:35 +0000 | 
|---|---|---|
| committer | Peter Bacon Darwin | 2014-02-16 19:03:41 +0000 | 
| commit | 2f7c57233ad2d578952dbba5c63ae8d50c1b487a (patch) | |
| tree | c14f91ad8429dd4c0b93bbc89dbd37ac4382f1e2 /src/ngMock/angular-mocks.js | |
| parent | 1192ae44f1d7f944719520f235e9f2ec895bdfd5 (diff) | |
| download | angular.js-2f7c57233ad2d578952dbba5c63ae8d50c1b487a.tar.bz2 | |
docs(bike-shed-migration): let markdown deal with extenal links
It is problematic to use {@link} tags with external links because the
markdown parser converts them to links for us before we parse the @links.
This means that the following tag:
```
{@link http://www.google.com Google}
```
get converted to:
```
{@link <a href="http://www.google.com/"></a> Google}
```
Our {@link} parser then converts this to:
```
<a href="<a"><</a>href="http://www.google.com/"></a> Google}
```
which is clearly a mess.  The best solution is not to use {@link} tags
for external links and just use the standard markdown syntax:
```
[Google](http://www.google.com)
```
In the long run, we could look into configuring or modifying `marked` not
to convert these external links or we could provide a "pre-parser"
processor that dealt with such links before `marked` gets its hands on it.
Diffstat (limited to 'src/ngMock/angular-mocks.js')
| -rw-r--r-- | src/ngMock/angular-mocks.js | 4 | 
1 files changed, 2 insertions, 2 deletions
| diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js index fe25254f..17c32452 100644 --- a/src/ngMock/angular-mocks.js +++ b/src/ngMock/angular-mocks.js @@ -869,8 +869,8 @@ angular.mock.dump = function(object) {   * development please see {@link ngMockE2E.$httpBackend e2e $httpBackend mock}.   *   * During unit testing, we want our unit tests to run quickly and have no external dependencies so - * we don’t want to send {@link https://developer.mozilla.org/en/xmlhttprequest XHR} or - * {@link http://en.wikipedia.org/wiki/JSONP JSONP} requests to a real server. All we really need is + * we don’t want to send [XHR](https://developer.mozilla.org/en/xmlhttprequest) or + * [JSONP](http://en.wikipedia.org/wiki/JSONP) requests to a real server. All we really need is   * to verify whether a certain request has been sent or not, or alternatively just let the   * application make requests, respond with pre-trained responses and assert that the end result is   * what we expect it to be. | 
