Skip to content

Commit

Permalink
Update README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
dkubb committed Sep 7, 2013
1 parent 286c7e1 commit 3c962c9
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,17 +126,20 @@ rules:
exclude: []
```
To disable a rule for some part of the code use
To disable a rule for some part of the code use:
```yaml
rules:
ApiTag::Presence:
enabled: true
exclude:
- Foo::Bar # class or module
- Foo#bar # instance method
- Foo.bar # class method
- Foo::Bar # class or module
- Foo#bar # instance method
- Foo.bar # class method
```
Rake tasks take these options as a second argument. Example:
Rake tasks take these options as a second argument:
```ruby
options = YAML.load_file('config/yardstick.yml')

Expand Down

0 comments on commit 3c962c9

Please sign in to comment.