-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add more YARD docs #1740
Add more YARD docs #1740
Conversation
- Pokemon - Sonic the Hedgehog - Heroes of the Storm
- Heroes 3 - Dragon Ball - Myst - World of Warcraft
- IndustrySegments - ElectricalComponents - GreekPhilosophers
One interesting thing I've noticed is that YARD seems to pick up So when you have something like this: # Returns 'foo'.
#
# @return [String]
def method_name
'foo'
end It assumes |
Also, in case anyone is curious, my main goal for adding all these YARD docs is to enable automatically generating types and documentation for Faker using Sord, so I can have it with Sorbet in my editor :) |
I saw that issue with Faker::String while I was experimenting. No real fix for it unfortunately. On a side note, I noticed that the doc coverage badge in the readme points to the wrong repo. Can you add a quick fix for that? |
@Zeragamba fixed. |
Looks good to me. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
# @example | ||
# Faker::Appliance.equipment #=> "Appliance plug" | ||
# | ||
# @faker.version 1.9.0 | ||
def equipment | ||
fetch('appliance.equipment') | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
END
* Add YARD docs for a few games. - Pokemon - Sonic the Hedgehog - Heroes of the Storm * Add more YARD docs for games and anime. - Heroes 3 - Dragon Ball - Myst - World of Warcraft * Add YARD docs for some miscellaneous classes. - IndustrySegments - ElectricalComponents - GreekPhilosophers * Add YARD docs for Device and Dessert fakers. * Add YARD doc for Faker::RockBand * Fix typo in DragonBall YARD doc. * Add YARD docs for Dota and League of Legends. * Add YARD docs for The Witcher. * Add YARD docs for Faker::Military * Add YARD docs for Faker::Appliance. * Add YARD docs for Faker::Subscription. * Add YARD docs for SAO. * Add YARD docs for The Hobbit. * Add a YARD doc for Faker::Movie * Add YARD docs for Faker::Science. * Add YARD docs for Faker::Marketing. * Add YARD docs for Faker::Superhero. * Add YARD doc for Faker::NatoPhoneticAlphabet. * Add YARD docs for GratefulDead and Phish. * Update Inch CI badge in README. * Change Inch CI link to HTTPS.
* Add YARD docs for a few games. - Pokemon - Sonic the Hedgehog - Heroes of the Storm * Add more YARD docs for games and anime. - Heroes 3 - Dragon Ball - Myst - World of Warcraft * Add YARD docs for some miscellaneous classes. - IndustrySegments - ElectricalComponents - GreekPhilosophers * Add YARD docs for Device and Dessert fakers. * Add YARD doc for Faker::RockBand * Fix typo in DragonBall YARD doc. * Add YARD docs for Dota and League of Legends. * Add YARD docs for The Witcher. * Add YARD docs for Faker::Military * Add YARD docs for Faker::Appliance. * Add YARD docs for Faker::Subscription. * Add YARD docs for SAO. * Add YARD docs for The Hobbit. * Add a YARD doc for Faker::Movie * Add YARD docs for Faker::Science. * Add YARD docs for Faker::Marketing. * Add YARD docs for Faker::Superhero. * Add YARD doc for Faker::NatoPhoneticAlphabet. * Add YARD docs for GratefulDead and Phish. * Update Inch CI badge in README. * Change Inch CI link to HTTPS.
Add YARD docs for the following fakers:
Faker::Device
Faker::Dessert
Faker::Appliance
Faker::Subscription
Faker::Military
Faker::Movie
Faker::Science
Faker::Superhero
Faker::Marketing
Faker::NatoPhoneticAlphabet
Faker::IndustrySegments
Faker::ElectricalComponents
Faker::GreekPhilosophers
Faker::Music::RockBand
Faker::Music::GratefulDead
Faker::Music::Phish
Faker::Games::Witcher
Faker::Games::Dota
Faker::Games::LeagueOfLegends
Faker::Games::Heroes
Faker::Games::HeroesOfTheStorm
Faker::Games::Myst
Faker::Games::WorldOfWarcraft
Faker::Games::Pokemon
Faker::Games::SonicTheHedgehog
Faker::JapaneseMedia::DragonBall
Faker::JapaneseMedia::SwordArtOnline
Faker::Movies::TheHobbit
This completes adding YARD docs for all the Faker::Games classes :D
This brings YARD doc coverage up from 18.57% to 27.02% :)