You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: STYLEGUIDE.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -586,7 +586,7 @@ Use slashes for both single line and multi line comments. Try to write
586
586
comments that explain higher level mechanisms or clarify difficult
587
587
segments of your code. **Don't use comments to restate trivial things**.
588
588
589
-
***Exception:*** Comment blocks describing a function and it's arguments (docblock) should start with `/**`, contain a single `*` at the begining of each line, and end with `*/`.
589
+
***Exception:*** Comment blocks describing a function and its arguments (docblock) should start with `/**`, contain a single `*` at the beginning of each line, and end with `*/`.
590
590
591
591
*Right:*
592
592
@@ -656,7 +656,7 @@ function ClassName() {
656
656
varClassName=function () {};
657
657
```
658
658
659
-
### Inhertiance should be done with a utility
659
+
### Inheritance should be done with a utility
660
660
661
661
While you can do it with pure JS, a utility will remove a lot of boilerplate, and be more readable and functional.
It is often the case that there are properties that can't be defined on the prototype, or work that needs to be done to completely create an object (like call it's Super class). This is all that should be done within constructors.
688
+
It is often the case that there are properties that can't be defined on the prototype, or work that needs to be done to completely create an object (like call its Super class). This is all that should be done within constructors.
689
689
690
690
Try to follow the [Write small functions](#write-small-functions) rule here too.
691
691
@@ -775,7 +775,7 @@ Several already exist, and can be found in `src/kibana/utils/_mixins.js`
775
775
776
776
## Filenames
777
777
778
-
All filenames should use `snake_case` and *can* start with an underscore if the module is not intended to be used outside of it's containing module.
778
+
All filenames should use `snake_case` and *can* start with an underscore if the module is not intended to be used outside of its containing module.
Angular routes are defined using a custom require modules named `routes` that remove much of the required boilerplate.
859
+
Angular routes are defined using a custom require module named `routes` that remove much of the required boilerplate.
860
860
861
861
```js
862
862
require('ui/routes')
@@ -869,7 +869,7 @@ require('ui/routes')
869
869
870
870
## Multiple attribute values
871
871
872
-
When a node has multiple attributes that would cause it to exceed the line character limit, each attribute including the first should be on its own line with a single indent. Also, when a node that is styled in this way has child nodes, there should be a blank line between the openening parent tag and the first child tag.
872
+
When a node has multiple attributes that would cause it to exceed the line character limit, each attribute including the first should be on its own line with a single indent. Also, when a node that is styled in this way has child nodes, there should be a blank line between the opening parent tag and the first child tag.
0 commit comments