Faker: Complete YARD docs

[connorshea]

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

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