Skip to content

Commit

Permalink
Exclude string.rb from consideration by YARD.
Browse files Browse the repository at this point in the history
This is necessary because otherwise YARD will assume all
references to "String" mean Faker::String.

The long-term solution for this is probably to deprecate Faker::String
and move the Faker::String.random method into Faker::Types.
  • Loading branch information
connorshea committed Dec 5, 2019
1 parent d2a0914 commit a2b9cbb
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .yardopts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
--no-private
--tag faker.version:"Available since"
--exclude lib/faker/deprecate/
--exclude lib/faker/default/string.rb
--output-dir yard_docs
lib/**/*.rb
lib/**/*.rb

0 comments on commit a2b9cbb

Please sign in to comment.