docs($http): clarify documentation on error status codes

provegard · pkozlowski-opensource · commit f3188c1d09e1 · 2013-01-03T20:47:55.000+01:00
Modify the documentation for $http to correspond to what Angular considers a success status code. Closes angular#1693
diff --git a/src/ng/http.js b/src/ng/http.js
@@ -172,8 +172,7 @@ function $HttpProvider() {
      *     }).
      *     error(function(data, status, headers, config) {
      *       // called asynchronously if an error occurs
-     *       // or server returns response with status
-     *       // code outside of the <200, 400) range
+     *       // or server returns response with an error status.
      *     });
      * </pre>
      *
@@ -182,6 +181,10 @@ function $HttpProvider() {
      * an object representing the response. See the api signature and type info below for more
      * details.
      *
+     * A response status code that falls in the [200, 300) range is considered a success status and
+     * will result in the success callback being called. Note that if the response is a redirect,
+     * XMLHttpRequest will transparently follow it, meaning that the error callback will not be
+     * called for such responses.
      *
      * # Shortcut methods
      *

Original file line number	Diff line number	Diff line change
`@@ -172,8 +172,7 @@ function $HttpProvider() {`
`172`	`172`	`* }).`
`173`	`173`	`* error(function(data, status, headers, config) {`
`174`	`174`	`* // called asynchronously if an error occurs`
`175`		`- * // or server returns response with status`
`176`		`- * // code outside of the <200, 400) range`
	`175`	`+ * // or server returns response with an error status.`
`177`	`176`	`* });`
`178`	`177`	`* </pre>`
`179`	`178`	`*`
`@@ -182,6 +181,10 @@ function $HttpProvider() {`
`182`	`181`	`* an object representing the response. See the api signature and type info below for more`
`183`	`182`	`* details.`
`184`	`183`	`*`
	`184`	`+ * A response status code that falls in the [200, 300) range is considered a success status and`
	`185`	`+ * will result in the success callback being called. Note that if the response is a redirect,`
	`186`	`+ * XMLHttpRequest will transparently follow it, meaning that the error callback will not be`
	`187`	`+ * called for such responses.`
`185`	`188`	`*`
`186`	`189`	`* # Shortcut methods`
`187`	`190`	`*`