Complete YARD docs

[connorshea]

Here are all the Faker classes that have been updated with YARD docs/need to be updated:

• Blockchain
  • Aeternity (Add Faker::Blockchain::Aeternity #1742)
  • Bitcoin (Yard powered docs #1553)
  • Ethereum (Yard powered docs #1553)
  • Tezos (Yard powered docs #1553)
• Books
  • Book (Yard powered docs #1553)
  • Culture (Yard powered docs #1553) - Still needs descriptions for the YARD docs.
  • Dune (Yard powered docs #1553)
  • Lovecraft (Yard powered docs #1553)
• Creature
  • Animal (Yard powered docs #1553)
  • Cat (Yard powered docs #1553)
  • Dog (Yard powered docs #1553)
  • Horse (Yard powered docs #1553)
• Default
  • Address (Add YARD docs for Faker::Address #1766)
  • Alphanumeric (Yard powered docs #1553)
  • Ancient (Add more YARD docs #1769)
  • App (Yard powered docs #1553)
  • Appliance (Add more YARD docs #1740)
  • Artist (Yard powered docs #1553)
  • Avatar (Yard powered docs #1553)
  • Bank (Add YARD docs to Faker::Bank #1989)
  • Beer (add Faker::Beer YARD docs #1790)
  • Boolean (Yard powered docs #1553)
  • Bossa Nova (Add YARD docs for Faker::BossaNova. #1849)
  • Business (Add YARD docs for Faker::Business #1852)
  • Cannabis (Add YARD doc for Faker::Cannabis #1949)
  • Chile RUT (Add YARD docs to Faker::Chile_Rut #2054)
  • Chuck Norris (Add more YARD docs #1769)
  • Code (Add YARD doc for Faker::Code #2058)
  • Coffee (Add yard docs for Faker::Coffee methods #1810)
  • Coin (add YARD doc for Faker::Coin  #1803)
  • Color (Add more YARD docs #1769)
  • Commerce (Add YARD docs to Faker::Commerce #1995)
  • Company (Add yard docs for Faker::Company #1915)
  • Compass (Add YARD docs for Faker::Compass #1975)
  • Construction (Add YARD docs for Faker::Construction #1980)
  • Cosmere (Add YARD docs to Faker::Cosmere #1982)
  • Crypto (Add YARD docs for Faker::Crypto. #1851)
  • Crypto Coin (Add YARD docs to Faker::Crypto_Coin #1996)
  • Currency (Add more YARD docs #1769)
  • Date (Add YARD docs for Date, Time, and Number #1753)
  • DC Comics (Add YARD docs for Faker::DcComics #1913)
  • Demographic (Add YARD Docs for Faker::Demographic. #1848)
  • Dessert (Add more YARD docs #1740)
  • Device (Add more YARD docs #1740)
  • Driving Licence (Add YARD docs to Faker::Driving_Licence #1997)
  • Educator (Refactor Faker::Educator and add docs #1772)
  • Electrical Components (Add more YARD docs #1740)
  • Esport (Add more YARD docs #1769)
  • File (Add YARD docs to Faker::File #1990)
  • Fillmurray (Add more YARD docs #1769)
  • Finance (Add YARD docs to Faker::Finance #1998)
  • Food (add YARD doc for Faker::Food #1802)
  • Funny Name (Add yard docs for Faker::FunnyName #1944)
  • Gender (Yard powered docs #1553)
  • Greek Philosophers (Add more YARD docs #1740)
  • Hacker (Yard powered docs #1553)
  • Hipster (Add YARD docs to Faker::Hipster #2021)
  • House (Yard powered docs #1553)
  • ID Number (Add YARD docs to Faker::ID_Number #2035)
  • Industry Segments (Add more YARD docs #1740)
  • Internet (Yard powered docs #1553)
  • Invoice (Add YARD docs to Faker::Invoice #2022)
  • Job (add YARD doc for Faker::Job #1797)
  • JSON (Add YARD docs to Faker::JSON #2000)
  • K-pop (Add YARD docs for Faker::Kpop. #1850)
  • Lorem (Yard powered docs #1553)
  • Lorem Flickr (Add YARD docs to Faker::Lorem_Flickr #2053)
  • Lorem Pixel (Add YARD docs to Faker::Lorem_Pixel #2052)
  • Markdown (Add YARD docs to Faker::Markdown #2036)
  • Marketing (Add more YARD docs #1740)
  • Measurement (Add YARD docs to Faker::Measurement #2020)
  • Military (Add more YARD docs #1740)
  • Name (Add YARD docs for Faker::Name #1976)
  • Nation (Add more miscellaneous YARD docs #1756)
  • Nato Phonetic Alphabet (Add more YARD docs #1740)
  • NHS (Add YARD docs to Faker::NHS #2055)
  • Number (Add YARD docs for Date, Time, and Number #1753)
  • Omniauth (Add YARD docs to Faker::Omniauth #2051)
  • Phone Number (Add YARD docs to Faker::Phone Number #2007)
  • Placeholdit (Add YARD docs to Faker::Placeholdit #2009)
  • Programming Language (Yard powered docs #1553)
  • Relationship (add Faker::Relationship YARD docs #1793)
  • Restaurant (Add YARD docs for Faker::Restaurant #1768)
  • Science (Add more YARD docs #1740)
  • Slack Emoji (add YARD docs to Faker::SlackEmoji #1956)
  • Source (Yard powered docs #1553)
  • South Africa (Add YARD docs to Faker::South_Africa #2001)
  • Space (Add more YARD docs #1769)
  • String (Add YARD docs to Faker::String #2004)
  • Stripe (Add YARD docs to Faker::Stripe #1981)
  • Subscription (Add more YARD docs #1740)
  • Superhero (Add more YARD docs #1740)
  • Team (Add more YARD docs #1769)
  • Time (Add YARD docs for Date, Time, and Number #1753)
  • Twitter (Add YARD docs to Faker::Twitter #1983)
  • Types (Add YARD docs to Faker::Types #1999)
  • University (add YARD docs to Faker::University #1959)
  • Vehicle (Add YARD docs for Faker::Vehicle #1993)
  • Verb (Add YARD docs for Faker:Verb #1916 Add YARD docs to Faker::Verb #2008)
  • World Cup (Faker::WorldCup YARD docs #1789)
• Games
  • Dota (Add more YARD docs #1740)
  • Half Life (Yard powered docs #1553)
  • Myst (Add more YARD docs #1740)
  • Super Smash Bros (Yard powered docs #1553)
  • Elder Scrolls (Yard powered docs #1553)
  • Heroes (Add more YARD docs #1740)
  • Overwatch (Yard powered docs #1553)
  • Witcher (Add more YARD docs #1740)
  • Fallout (Yard powered docs #1553)
  • Heroes Of The Storm (Add more YARD docs #1740)
  • Pokemon (Add more YARD docs #1740)
  • World Of Warcraft (Add more YARD docs #1740)
  • Game (Yard powered docs #1553)
  • League Of Legends (Add more YARD docs #1740)
  • Sonic The Hedgehog (Add more YARD docs #1740)
  • Legend of Zelda (Add more YARD docs #1740)
• JapaneseMedia
  • Sword Art Online (Add more YARD docs #1740)
  • One Piece (Add more miscellaneous YARD docs #1756)
  • Dragon Ball (Add more YARD docs #1740)
• Movies
  • Movie (Add more YARD docs #1740)
  • Back To The Future (Add more miscellaneous YARD docs #1756)
  • The Hobbit (Add more YARD docs #1740)
  • Princess Bride (Add more miscellaneous YARD docs #1756)
  • Ghostbusters (Add more miscellaneous YARD docs #1756)
  • Lebowski (Add more miscellaneous YARD docs #1756)
  • Star Wars (Add more miscellaneous YARD docs #1756)
  • Harry Potter (Add more miscellaneous YARD docs #1756)
  • Lord Of The Rings (Add more miscellaneous YARD docs #1756)
  • V For Vendetta (Add more miscellaneous YARD docs #1756)
  • Hitchhikers Guide To The Galaxy (Add more miscellaneous YARD docs #1756)
• Music
  • Grateful Dead (Add more YARD docs #1740)
  • Music (Add YARD docs for Faker::Music{,::Opera} #1873)
  • Opera (Add YARD docs for Faker::Music{,::Opera} #1873)
  • Phish (Add more YARD docs #1740)
  • Rock Band (Add more YARD docs #1740)
  • Umphrey's McGee (Add YARD docs for all remaining TV Shows #1759)
• Quotes (Add YARD docs to Faker::Quotes #2015)
  • Quote (Add YARD docs to Faker::Quotes #2015)
  • Shakespeare (Add YARD docs to Faker::Quotes #2015)
• Sports
  • Basketball (Add YARD docs for the Basketball and Football fakers. #1761)
  • Football (Add YARD docs for the Basketball and Football fakers. #1761)
• TvShows
  • Aqua Teen Hunger Force (Add YARD docs for all remaining TV Shows #1759)
  • Friends (Add YARD docs for all remaining TV Shows #1759)
  • Ru Paul (Add YARD docs for all remaining TV Shows #1759)
  • The Expanse (Add YARD docs for all remaining TV Shows #1759)
  • Bojack Horseman (Add YARD docs for all remaining TV Shows #1759)
  • Game Of Thrones (Add YARD docs for all remaining TV Shows #1759)
  • Seinfeld (Add YARD docs for all remaining TV Shows #1759)
  • The Fresh Prince Of Bel-Air (Add YARD docs for all remaining TV Shows #1759)
  • Breaking Bad
  • Hey Arnold (Add YARD docs for all remaining TV Shows #1759)
  • Silicon Valley (Add YARD docs for all remaining TV Shows #1759)
  • The IT Crowd (Add YARD docs for all remaining TV Shows #1759)
  • Buffy (Add YARD docs for all remaining TV Shows #1759)
  • How I Met Your Mother (Add YARD docs for all remaining TV Shows #1759)
  • Simpsons (Add YARD docs for all remaining TV Shows #1759)
  • The Thick Of It (Add YARD docs for all remaining TV Shows #1759)
  • Community (Add YARD docs for all remaining TV Shows #1759)
  • Michael Scott (Add YARD docs for all remaining TV Shows #1759)
  • South Park (Add YARD docs for all remaining TV Shows #1759)
  • Twin Peaks (Add YARD docs for all remaining TV Shows #1759)
  • Doctor Who (Add YARD docs for Doctor Who and fix a method name. #1758)
  • New Girl (Add YARD docs for all remaining TV Shows #1759)
  • Star Trek (Add YARD docs for all remaining TV Shows #1759)
  • Venture Bros (Add YARD docs for all remaining TV Shows #1759)
  • Dumb And Dumber (Add YARD docs for all remaining TV Shows #1759)
  • Parks And Rec (Add YARD docs for all remaining TV Shows #1759)
  • Stargate (Add YARD docs for all remaining TV Shows #1759)
  • Family Guy (Add YARD docs for all remaining TV Shows #1759)
  • Rick And Morty (Add YARD docs for all remaining TV Shows #1759)
  • Stranger Things (Add YARD docs for all remaining TV Shows #1759)

[Zeragamba]

Oh, I love checklists!

[ashishra0]

Hey @connorshea
Can you please update the checklist? It would be very helpful.
Cheers

[connorshea]

@ashishra0 it should be updated now, I don't check things off until they've been merged into master.

[ashishra0]

@connorshea Yeah makes sense. Thanks though!

[vbrazo]

That's pretty awesome 💥

[Omoyeni663]

I am still in chapter 3 of my course, I need someone to put me through... Better on Twitter @Melebroz1

[connorshea]

I've updated the issue description with all the new PRs :)

[danielTiringer]

The last one's left is Faker::Code which has an open PR already.
If you want me to complete the Code YARD docs too, please close the existing PR.

[connorshea]

@danielTiringer thank you for all the work! 🙏 Looks like @Zeragamba has created the updated PR for Faker::Code, so that'll be the last one we need to merge and then this'll be finished :)

[Zeragamba]

And that's the last one merged to master!

[connorshea]

Thanks for the great work everybody!

[vbrazo]

That was awesome! Thanks!