mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
[GH-2793] Exclude examples from documented methods
Example code in various providers directories is getting picked up by Yard when documenting such that a number of global constants and helpers are appearing to be part of fog. This excludes them using `.yardopts` It also excludes generated documentation from provider subdirectories from git.
This commit is contained in:
parent
040fb95075
commit
0ff2217789
2 changed files with 3 additions and 0 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -26,3 +26,5 @@ spec/credentials.yml
|
|||
vendor/*
|
||||
tags
|
||||
tests/digitalocean/fixtures/
|
||||
|
||||
providers/*/doc
|
||||
|
|
1
.yardopts
Normal file
1
.yardopts
Normal file
|
@ -0,0 +1 @@
|
|||
--exclude 'lib/fog/.*/examples'
|
Loading…
Add table
Reference in a new issue