Skip to content

Commit

Permalink
Docs: fix wrong default (fixes #300)(#303)
Browse files Browse the repository at this point in the history
* Update docs, mark fixable rule
* Update defaults in  max-attributes-per-line docs
  • Loading branch information
michalsnik authored and mysticatea committed Dec 23, 2017
1 parent 7752f5a commit dc61f9d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Enforce all the rules in this category, as well as all higher priority rules, wi
| | [no-duplicate-attributes](./docs/rules/no-duplicate-attributes.md) | disallow duplication of attributes |
| | [no-parsing-error](./docs/rules/no-parsing-error.md) | disallow parsing errors in `<template>` |
| | [no-reserved-keys](./docs/rules/no-reserved-keys.md) | disallow overwriting reserved keys |
| | [no-shared-component-data](./docs/rules/no-shared-component-data.md) | enforce component's data property to be a function |
| :wrench: | [no-shared-component-data](./docs/rules/no-shared-component-data.md) | enforce component's data property to be a function |
| | [no-side-effects-in-computed-properties](./docs/rules/no-side-effects-in-computed-properties.md) | disallow side effects in computed properties |
| | [no-template-key](./docs/rules/no-template-key.md) | disallow `key` attribute on `<template>` |
| | [no-textarea-mustache](./docs/rules/no-textarea-mustache.md) | disallow mustaches in `<textarea>` |
Expand Down Expand Up @@ -181,7 +181,7 @@ Enforce all the rules in this category, as well as all higher priority rules, wi

| | Rule ID | Description |
|:---|:--------|:------------|
| | [html-quotes](./docs/rules/html-quotes.md) | enforce quotes style of HTML attributes |
| :wrench: | [html-quotes](./docs/rules/html-quotes.md) | enforce quotes style of HTML attributes |
| | [no-confusing-v-for-v-if](./docs/rules/no-confusing-v-for-v-if.md) | disallow confusing `v-for` and `v-if` on the same element |
| | [order-in-components](./docs/rules/order-in-components.md) | enforce order of properties in components |
| | [this-in-template](./docs/rules/this-in-template.md) | enforce usage of `this` in template |
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/html-quotes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# enforce quotes style of HTML attributes (html-quotes)

- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

You can choose quotes of HTML attributes from:

- Double quotes: `<div class="foo">`
Expand Down
4 changes: 2 additions & 2 deletions docs/rules/max-attributes-per-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This rule aims to enforce a number of attributes per line in templates.
It checks all the elements in a template and verifies that the number of attributes per line does not exceed the defined maximum.
An attribute is considered to be in a new line when there is a line break between two attributes.

There is a configurable number of attributes that are acceptable in one-line case (default 3), as well as how many attributes are acceptable per line in multi-line case (default 1).
There is a configurable number of attributes that are acceptable in one-line case (default 1), as well as how many attributes are acceptable per line in multi-line case (default 1).

:-1: Examples of **incorrect** code for this rule:

Expand Down Expand Up @@ -48,7 +48,7 @@ There is a configurable number of attributes that are acceptable in one-line cas
```json
{
"vue/max-attributes-per-line": [2, {
"singleline": 3,
"singleline": 1,
"multiline": {
"max": 1,
"allowFirstLine": false
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-shared-component-data.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# enforce component's data property to be a function (no-shared-component-data)

- :wrench: The `--fix` option on the [command line](http://eslint.org/docs/user-guide/command-line-interface#fix) can automatically fix some of the problems reported by this rule.

When using the data property on a component (i.e. anywhere except on `new Vue`), the value must be a function that returns an object.

## :book: Rule Details
Expand Down

0 comments on commit dc61f9d

Please sign in to comment.