Skip to content
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

Merged
merged 14 commits into from Sep 20, 2019
Merged

Conversation

connorshea
Copy link
Member

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.

Screen Shot 2019-09-19 at 8 13 04 PM

@Zeragamba
Copy link
Contributor

Was wondering when someone was going to automate this :P

Copy link
Contributor

@Zeragamba Zeragamba left a 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!

@connorshea
Copy link
Member Author

D'oh, I knew I'd screw something up. It should be fixed for all of them now.

@Zeragamba
Copy link
Contributor

Looks good to me. Thanks!

Copy link
Member

@vbrazo vbrazo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@vbrazo vbrazo merged commit a2c7887 into faker-ruby:master Sep 20, 2019
@connorshea connorshea deleted the misc-yard-docs branch September 20, 2019 23:23
@connorshea connorshea mentioned this pull request Sep 21, 2019
michebble pushed a commit to michebble/faker that referenced this pull request Feb 16, 2020
* 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.
davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021
* 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants