From d2be5939dc7ec3b756a34175b2af5c99427411c0 Mon Sep 17 00:00:00 2001
From: Spencer Applegate
Date: Fri, 28 Jun 2013 23:00:31 -0400
Subject: docs(Angular.js): explain that toJson strips $... properties

In Angular.toJson, any properties with a leading '$' character will be
stripped from the resulting string since angular uses this notation
internally for services.  There have been complaints of not knowing
about this functionality until it breaks within their code.
---
 src/Angular.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src/Angular.js')

diff --git a/src/Angular.js b/src/Angular.js
index eeafb8b7..95b20139 100644
--- a/src/Angular.js
+++ b/src/Angular.js
@@ -746,7 +746,8 @@ function toJsonReplacer(key, value) {
  * @function
  *
  * @description
- * Serializes input into a JSON-formatted string.
+ * Serializes input into a JSON-formatted string. Properties with leading $ characters will be
+ * stripped since angular uses this notation internally.
  *
  * @param {Object|Array|Date|string|number} obj Input to be serialized into JSON.
  * @param {boolean=} pretty If set to true, the JSON output will contain newlines and whitespace.
-- 
cgit v1.2.3