X Tutup
The Wayback Machine - https://web.archive.org/web/20201218092125/https://github.com/faker-ruby/faker/pull/1756
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
Contributor

@connorshea connorshea commented Sep 20, 2019

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

connorshea added 12 commits Sep 19, 2019
@Zeragamba
Copy link
Contributor

@Zeragamba Zeragamba commented Sep 20, 2019

Was wondering when someone was going to automate this :P

Copy link
Contributor

@Zeragamba Zeragamba left a comment

Missing the ## for the first line of the DocBlocks

Automation for the win!

connorshea added 2 commits Sep 20, 2019
@connorshea
Copy link
Contributor Author

@connorshea connorshea commented Sep 20, 2019

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

@Zeragamba
Copy link
Contributor

@Zeragamba Zeragamba commented Sep 20, 2019

Looks good to me. Thanks!

@vbrazo
vbrazo approved these changes Sep 20, 2019
Copy link
Member

@vbrazo vbrazo left a comment

👍

@vbrazo vbrazo merged commit a2c7887 into faker-ruby:master Sep 20, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@connorshea connorshea deleted the connorshea:misc-yard-docs branch Sep 20, 2019
@connorshea connorshea mentioned this pull request Sep 21, 2019
181 of 181 tasks complete
michebble added 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.
X Tutup