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 miscellaneous YARD docs #1756
Conversation
Was wondering when someone was going to automate this :P |
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.
Missing the ##
for the first line of the DocBlocks
Automation for the win!
D'oh, I knew I'd screw something up. It should be fixed for all of them now. |
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.
👍
* Add YARD docs for Faker::Nation. * Add YARD docs for One Piece. * Add YARD docs for The Big Lebowski. * Add YARD docs for Star Wars. * Add YARD docs for HarryPotter. * Add YARD docs for Back to the Future. * Add YARD docs for Ghostbusters. * Add YARD docs for Lord of the Rings. * Add YARD docs for The Princess Bride. * Add YARD docs for V For Vendetta. * Fixes to appease rubocop. * Add YARD docs for Hitchhiker's Guide to the Galaxy. * Fix missing double-hashes at the start of doc blocks. * Fix it for One Piece as well.
* Add YARD docs for Faker::Nation. * Add YARD docs for One Piece. * Add YARD docs for The Big Lebowski. * Add YARD docs for Star Wars. * Add YARD docs for HarryPotter. * Add YARD docs for Back to the Future. * Add YARD docs for Ghostbusters. * Add YARD docs for Lord of the Rings. * Add YARD docs for The Princess Bride. * Add YARD docs for V For Vendetta. * Fixes to appease rubocop. * Add YARD docs for Hitchhiker's Guide to the Galaxy. * Fix missing double-hashes at the start of doc blocks. * Fix it for One Piece as well.
Mostly for
Faker::Movies
subclasses.I got tired of doing this manually, so I wrote a script to make the process of generating these much easier :)
https://gist.github.com/connorshea/d1f5e0aa2e79575dc68e651a06dad192
You give it information about the class, methods, etc., and it outputs the YARD comments. It doesn't support parameters right now since they're not really used much in Movies/Games/TvShows.