Skip to content

Commit b11120b

Browse files
isaaclymanNarretz
authored andcommitted
docs($cookiesProvider): clarify parameters description
Fixed a grammatical mistake ("equals to"), made hyphenation consistent, fixed punctuation and clarified the sentence structure. Closes angular#13853
1 parent bfba95c commit b11120b

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/ngCookies/cookies.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,17 @@ angular.module('ngCookies', ['ng']).
3434
* The object may have following properties:
3535
*
3636
* - **path** - `{string}` - The cookie will be available only for this path and its
37-
* sub-paths. By default, this would be the URL that appears in your base tag.
37+
* sub-paths. By default, this is the URL that appears in your `<base>` tag.
3838
* - **domain** - `{string}` - The cookie will be available only for this domain and
39-
* its sub-domains. For obvious security reasons the user agent will not accept the
40-
* cookie if the current domain is not a sub domain or equals to the requested domain.
39+
* its sub-domains. For security reasons the user agent will not accept the cookie
40+
* if the current domain is not a sub-domain of this domain or equal to it.
4141
* - **expires** - `{string|Date}` - String of the form "Wdy, DD Mon YYYY HH:MM:SS GMT"
4242
* or a Date object indicating the exact date/time this cookie will expire.
43-
* - **secure** - `{boolean}` - The cookie will be available only in secured connection.
43+
* - **secure** - `{boolean}` - If `true`, then the cookie will only be available through a
44+
* secured connection.
4445
*
45-
* Note: by default the address that appears in your `<base>` tag will be used as path.
46-
* This is important so that cookies will be visible for all routes in case html5mode is enabled
46+
* Note: By default, the address that appears in your `<base>` tag will be used as the path.
47+
* This is important so that cookies will be visible for all routes when html5mode is enabled.
4748
*
4849
**/
4950
var defaults = this.defaults = {};

0 commit comments

Comments
 (0)