Skip to content

Commit

Permalink
Update format of the @example YARD doc example
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeragamba authored May 19, 2020
1 parent 7a7c181 commit 76fd538
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,8 @@ Include [YARD] style docs for all methods that includes:
# @return [String]
#
# @example
# Faker::Alphanumeric.alpha
# #=> "kgdpxlgwjirlqhwhrebvuomdcjjpeqlq"
# @example
# Faker::Alphanumeric.alpha(number: 10)
# #=> "zlvubkrwga"
# Faker::Alphanumeric.alpha #=> "kgdpxlgwjirlqhwhrebvuomdcjjpeqlq"
# Faker::Alphanumeric.alpha(number: 10) #=> "zlvubkrwga"
#
# @faker.version next
def alpha(number: 32)
Expand Down Expand Up @@ -107,4 +104,4 @@ a_things:
* Use the `rake console` task to start a session with Faker loaded.
* Use `bundle exec yard server -r` to launch the YARD Doc server

[YARD]: (https://www.rubydoc.info/gems/yard/file/README.md)
[YARD]: (https://www.rubydoc.info/gems/yard/file/README.md)

0 comments on commit 76fd538

Please sign in to comment.