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

Commit 4593fcb

Browse files
committed
docs(ngShowHide): improve consistency in ngShowHide documentation
add backticks around directive names to improve documentation consistency
1 parent e7ac08a commit 4593fcb

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/ng/directive/ngShowHide.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
*
77
* @description
88
* The `ngShow` directive shows or hides the given HTML element based on the expression
9-
* provided to the ngShow attribute. The element is shown or hidden by removing or adding
10-
* the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
9+
* provided to the `ngShow` attribute. The element is shown or hidden by removing or adding
10+
* the `.ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
1111
* in AngularJS and sets the display style to none (using an !important flag).
1212
* For CSP mode please add `angular-csp.css` to your html file (see {@link ng.directive:ngCsp ngCsp}).
1313
*
@@ -19,13 +19,13 @@
1919
* <div ng-show="myValue" class="ng-hide"></div>
2020
* ```
2121
*
22-
* When the ngShow expression evaluates to a falsy value then the ng-hide CSS class is added to the class
23-
* attribute on the element causing it to become hidden. When truthy, the ng-hide CSS class is removed
22+
* When the `ngShow` expression evaluates to a falsy value then the `.ng-hide` CSS class is added to the class
23+
* attribute on the element causing it to become hidden. When truthy, the `.ng-hide` CSS class is removed
2424
* from the element causing the element not to appear hidden.
2525
*
2626
* ## Why is !important used?
2727
*
28-
* You may be wondering why !important is used for the .ng-hide CSS class. This is because the `.ng-hide` selector
28+
* You may be wondering why !important is used for the `.ng-hide` CSS class. This is because the `.ng-hide` selector
2929
* can be easily overridden by heavier selectors. For example, something as simple
3030
* as changing the display style on a HTML list item would make hidden elements appear visible.
3131
* This also becomes a bigger issue when dealing with CSS frameworks.

0 commit comments

Comments
 (0)