kotovalexarian-likes-github
/
fog--fog
mirror of https://github.com/fog/fog.git
1
0
Fork 0
Code Releases Activity

[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:
Paul Thornthwaite 2014-03-28 09:44:30 +00:00
parent 040fb95075
commit 0ff2217789
2 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -26,3 +26,5 @@ spec/credentials.yml
vendor/*
tags
tests/digitalocean/fixtures/
providers/*/doc

1
.yardopts Normal file
View File

@ -0,0 +1 @@
--exclude 'lib/fog/.*/examples'