Yard powered docs #1553

Zeragamba · 2019-02-24T00:24:16Z

Zeragamba · 2019-02-24T00:24:48Z

forgot to actually open this PR for #1330

richardbulger · 2019-03-08T13:26:00Z

Can CONTRIBUTING.md be updated with guidelines on how this should be used going forward?

Zeragamba · 2019-04-07T05:03:35Z

Updated contributing, and added some sample documentation to Faker::Alphanumeric, Faker::Book, and Faker::Books's subclasses.

connorshea · 2019-06-23T20:45:39Z

👍 this'd be great, especially for use with sord so it'd be easier to add Sorbet support (either officially in this repo or via sorbet-typed)

vbrazo · 2019-08-07T04:09:00Z

@Zeragamba can you update this branch with master? We'll move on with these changes for v3.

Zeragamba · 2019-08-07T10:36:55Z

Sure! Edit: remove email spam

bpleslie

Looks good to me!

lib/faker/blockchain/tezos.rb

lib/faker/creature/dog.rb

lib/faker/default/alphanumeric.rb

connorshea · 2019-08-13T01:59:09Z

Also, you should probably add doc/ to the .gitignore since running yard causes a bunch of files to be added.

connorshea · 2019-08-13T02:08:26Z

For the @examples, you're formatting them like this:

# @example Faker::Game.genre
#   "Real-time strategy"

when normally it would be more like:

# @example 
#   Faker::Game.platform #=> "Nintendo Switch"

You can see the rendered documentation for these two here:

I can make this change if you want it.

stympy · 2019-08-13T02:14:46Z

I do prefer the latter style, @connorshea

connorshea · 2019-08-13T02:36:58Z

I think I've updated all of them now, that wasn't as hard as I expected. https://github.com/Zeragamba/faker/pull/6

connorshea · 2019-08-13T04:14:38Z

@vbrazo just to clarify, you’re not saying this PR would need to wait until 3.0, right?

We can have the current docs and the YARD docs simultaneously without any problem, and the current docs would be the main source until we’ve moved everything over to YARD.

Zeragamba · 2019-08-13T14:26:22Z

@connorshea Sounds good. Left a few change requests there, I'll merge those in when one of us get the time to fix it. :)

.gitignore

Zeragamba · 2019-08-21T03:27:08Z

Lots of new docs from @connorshea so this is ready for re-review

connorshea · 2019-08-30T23:11:11Z

There are some new conflicts now.

This reverts commit b2c8000.

Some of the Elder Scrolls methods were added after others, in 1.9.0.

lib/faker/blockchain/bitcoin.rb

CONTRIBUTING.md

lib/faker/books/lovecraft.rb

Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> Update CONTRIBUTING.md to match new example format install Yard and go go gadget yard Revert "and go go gadget yard" This reverts commit b2c8000. fully document Faker::Blockchain exclude deprecated methods add version numbers to blockchain update documentation to match what was discussed in #1330 remove class level @faker.version from docs update CONTRIBUTING.md update existing yard docs clean up some of the docs

Zeragamba · 2019-09-11T02:22:13Z

live example of these docs: https://rubydoc.info/github/SpyMaster356/faker/master/Faker/Avatar

connorshea

LGTM 👍

vbrazo

👍

Zeragamba · 2019-09-11T02:50:19Z

It merged! Woooo :party:

connorshea · 2019-09-11T02:50:41Z

🎉

* Bump version to 2.3.0 * Add #1553 to 2.3.0 * Add connorshea to #1553 * Remove duplications * Add #1741

* install Yard * add some basic docs to test with * and go go gadget yard * Revert "and go go gadget yard" This reverts commit b2c8000. * use square brackets not braces * fully document Faker::Blockchain * exclude deprecated methods * add version numbers to blockchain * update documentation to match what was discussed in faker-ruby#1330 * remove class level @faker.version from docs * update CONTRIBUTING.md * add documentation to Alphanumeric * consistently use braces for types * document the Books namespace * add doc url * Add yard docs for Faker::Blockchain::Tezos.block * update docs for named params * convert back to [] for types Although YARD supports any kind of bracket for the Typing, square brackets are used in the documentation. For those contributing, and unfamiliar with YARD, it would be best that our documentation matches the same style as that in YARD's tutorials and documentation. * document Faker::Creature::Animal * document Faker::Creature::Cat * document Faker::Creature::Dog * document Faker::Creature::Horse * Update lib/faker/default/alphanumeric.rb Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> * Update lib/faker/creature/dog.rb Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> * document Faker::Game * document Faker::Games::HalfLife * document Faker::Games::Zelda * document Faker::Games::SuperSmashBros * document Faker::TvShows::BreakingBad * Document Faker::Games::ElderScrolls * document Faker::Gender * document Faker::House * document Faker::ProgrammingLanguage * document Faker::Source * Update some of the docs to use examples without titles. * Update a few more docs to use examples without titles. * Update more docs to use title-less examples. * document Faker::Boolean * document Faker::Avatar * document Faker::Games::Fallout * document Faker::Games::Overwatch * document Faker::Hacker * Fix a method description. * Remove trailing whitespace. * document Faker::App * Add faker version for BreakingBad methods. * Add faker version to Zelda methods. * document Faker::Artist * Merge the examples for semantic_version in app.rb. * Add faker versions for elder_scrolls.rb and fallout.rb. Some of the Elder Scrolls methods were added after others, in 1.9.0. * Update version tags in Elder Scrolls and Fallout. * Clean up docs Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> Update CONTRIBUTING.md to match new example format install Yard and go go gadget yard Revert "and go go gadget yard" This reverts commit b2c8000. fully document Faker::Blockchain exclude deprecated methods add version numbers to blockchain update documentation to match what was discussed in faker-ruby#1330 remove class level @faker.version from docs update CONTRIBUTING.md update existing yard docs clean up some of the docs * fix line ending issues

* Bump version to 2.3.0 * Add faker-ruby#1553 to 2.3.0 * Add connorshea to faker-ruby#1553 * Remove duplications * Add faker-ruby#1741

* install Yard * add some basic docs to test with * and go go gadget yard * Revert "and go go gadget yard" This reverts commit b2c8000. * use square brackets not braces * fully document Faker::Blockchain * exclude deprecated methods * add version numbers to blockchain * update documentation to match what was discussed in faker-ruby#1330 * remove class level @faker.version from docs * update CONTRIBUTING.md * add documentation to Alphanumeric * consistently use braces for types * document the Books namespace * add doc url * Add yard docs for Faker::Blockchain::Tezos.block * update docs for named params * convert back to [] for types Although YARD supports any kind of bracket for the Typing, square brackets are used in the documentation. For those contributing, and unfamiliar with YARD, it would be best that our documentation matches the same style as that in YARD's tutorials and documentation. * document Faker::Creature::Animal * document Faker::Creature::Cat * document Faker::Creature::Dog * document Faker::Creature::Horse * Update lib/faker/default/alphanumeric.rb Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> * Update lib/faker/creature/dog.rb Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> * document Faker::Game * document Faker::Games::HalfLife * document Faker::Games::Zelda * document Faker::Games::SuperSmashBros * document Faker::TvShows::BreakingBad * Document Faker::Games::ElderScrolls * document Faker::Gender * document Faker::House * document Faker::ProgrammingLanguage * document Faker::Source * Update some of the docs to use examples without titles. * Update a few more docs to use examples without titles. * Update more docs to use title-less examples. * document Faker::Boolean * document Faker::Avatar * document Faker::Games::Fallout * document Faker::Games::Overwatch * document Faker::Hacker * Fix a method description. * Remove trailing whitespace. * document Faker::App * Add faker version for BreakingBad methods. * Add faker version to Zelda methods. * document Faker::Artist * Merge the examples for semantic_version in app.rb. * Add faker versions for elder_scrolls.rb and fallout.rb. Some of the Elder Scrolls methods were added after others, in 1.9.0. * Update version tags in Elder Scrolls and Fallout. * Clean up docs Co-Authored-By: Connor Shea <connor.james.shea@gmail.com> Update CONTRIBUTING.md to match new example format install Yard and go go gadget yard Revert "and go go gadget yard" This reverts commit b2c8000. fully document Faker::Blockchain exclude deprecated methods add version numbers to blockchain update documentation to match what was discussed in faker-ruby#1330 remove class level @faker.version from docs update CONTRIBUTING.md update existing yard docs clean up some of the docs * fix line ending issues

* Bump version to 2.3.0 * Add faker-ruby#1553 to 2.3.0 * Add connorshea to faker-ruby#1553 * Remove duplications * Add faker-ruby#1741

vbrazo assigned Zeragamba Feb 26, 2019

vbrazo added the 💡 Issue: Feature Request label Feb 26, 2019

vbrazo force-pushed the master branch 3 times, most recently from 69291b2 to 5cc660c Compare July 5, 2019 17:21

bpleslie approved these changes Aug 8, 2019

View reviewed changes

Zeragamba force-pushed the yard-powered-docs branch from be7ceb7 to b64fc6f Compare August 12, 2019 23:23

Zeragamba commented Aug 12, 2019

View reviewed changes

lib/faker/blockchain/tezos.rb Show resolved Hide resolved

connorshea reviewed Aug 13, 2019

View reviewed changes

lib/faker/creature/dog.rb Outdated Show resolved Hide resolved

connorshea reviewed Aug 13, 2019

View reviewed changes

lib/faker/default/alphanumeric.rb Outdated Show resolved Hide resolved

connorshea reviewed Aug 13, 2019

View reviewed changes

lib/faker/default/alphanumeric.rb Outdated Show resolved Hide resolved

connorshea reviewed Aug 14, 2019

View reviewed changes

.gitignore Show resolved Hide resolved

Zeragamba added 4 commits September 10, 2019 21:22

install Yard

b63b519

add some basic docs to test with

feb3cda

and go go gadget yard

9155e99

Revert "and go go gadget yard"

bcff808

This reverts commit b2c8000.

connorshea added 6 commits September 10, 2019 21:32

Add faker version for BreakingBad methods.

645e155

Add faker version to Zelda methods.

1c20aee

document Faker::Artist

4dd0a24

Merge the examples for semantic_version in app.rb.

71470fb

Add faker versions for elder_scrolls.rb and fallout.rb.

1700c06

Some of the Elder Scrolls methods were added after others, in 1.9.0.

Update version tags in Elder Scrolls and Fallout.

b29bc49

Zeragamba force-pushed the yard-powered-docs branch 2 times, most recently from 100a035 to 8cfb1fc Compare September 11, 2019 01:39

Zeragamba commented Sep 11, 2019

View reviewed changes

lib/faker/blockchain/bitcoin.rb Outdated Show resolved Hide resolved

CONTRIBUTING.md Show resolved Hide resolved

lib/faker/books/lovecraft.rb Outdated Show resolved Hide resolved

lib/faker/books/lovecraft.rb Outdated Show resolved Hide resolved

Zeragamba force-pushed the yard-powered-docs branch from 5edd8b7 to 2023e30 Compare September 11, 2019 02:00

fix line ending issues

07671b3

connorshea approved these changes Sep 11, 2019

View reviewed changes

vbrazo approved these changes Sep 11, 2019

View reviewed changes

vbrazo merged commit f9798d5 into faker-ruby:master Sep 11, 2019

vbrazo added the 📘 Documentation label Sep 11, 2019

connorshea mentioned this pull request Sep 11, 2019

Bump version to 2.3.0 #1739

Merged

vbrazo added a commit that referenced this pull request Sep 11, 2019

Add #1553 to 2.3.0

5bcc787

vbrazo added a commit that referenced this pull request Sep 11, 2019

Add connorshea to #1553

d9961fd

vbrazo added a commit that referenced this pull request Sep 12, 2019

Bump version to 2.3.0 (#1739)

bb2226e

* Bump version to 2.3.0 * Add #1553 to 2.3.0 * Add connorshea to #1553 * Remove duplications * Add #1741

sanikkenway mentioned this pull request Sep 13, 2019

Bump version to 2.3.0 (#1739) sanikkenway/faker#66

Merged

connorshea mentioned this pull request Sep 21, 2019

Complete YARD docs #1762

Closed

michebble pushed a commit to michebble/faker that referenced this pull request Feb 16, 2020

Bump version to 2.3.0 (faker-ruby#1739)

fd0caf0

* Bump version to 2.3.0 * Add faker-ruby#1553 to 2.3.0 * Add connorshea to faker-ruby#1553 * Remove duplications * Add faker-ruby#1741

Zeragamba deleted the yard-powered-docs branch May 17, 2020 00:21

davidmorton0 pushed a commit to davidmorton0/faker that referenced this pull request Jul 12, 2021

Bump version to 2.3.0 (faker-ruby#1739)

ec98c03

* Bump version to 2.3.0 * Add faker-ruby#1553 to 2.3.0 * Add connorshea to faker-ruby#1553 * Remove duplications * Add faker-ruby#1741

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Yard powered docs #1553

Yard powered docs #1553

Zeragamba commented Feb 24, 2019 •

edited by vbrazo

Loading

Zeragamba commented Feb 24, 2019

richardbulger commented Mar 8, 2019

Zeragamba commented Apr 7, 2019

connorshea commented Jun 23, 2019

vbrazo commented Aug 7, 2019

Zeragamba commented Aug 7, 2019 via email •

edited

Loading

bpleslie left a comment

connorshea commented Aug 13, 2019

connorshea commented Aug 13, 2019

stympy commented Aug 13, 2019

connorshea commented Aug 13, 2019

connorshea commented Aug 13, 2019

Zeragamba commented Aug 13, 2019 •

edited

Loading

Zeragamba commented Aug 21, 2019

connorshea commented Aug 30, 2019

Zeragamba commented Sep 11, 2019

connorshea left a comment

vbrazo left a comment

Zeragamba commented Sep 11, 2019

connorshea commented Sep 11, 2019

Yard powered docs #1553

Yard powered docs #1553

Conversation

Zeragamba commented Feb 24, 2019 • edited by vbrazo Loading

Zeragamba commented Feb 24, 2019

richardbulger commented Mar 8, 2019

Zeragamba commented Apr 7, 2019

connorshea commented Jun 23, 2019

vbrazo commented Aug 7, 2019

Zeragamba commented Aug 7, 2019 via email • edited Loading

bpleslie left a comment

Choose a reason for hiding this comment

connorshea commented Aug 13, 2019

connorshea commented Aug 13, 2019

stympy commented Aug 13, 2019

connorshea commented Aug 13, 2019

connorshea commented Aug 13, 2019

Zeragamba commented Aug 13, 2019 • edited Loading

Zeragamba commented Aug 21, 2019

connorshea commented Aug 30, 2019

Zeragamba commented Sep 11, 2019

connorshea left a comment

Choose a reason for hiding this comment

vbrazo left a comment

Choose a reason for hiding this comment

Zeragamba commented Sep 11, 2019

connorshea commented Sep 11, 2019

Zeragamba commented Feb 24, 2019 •

edited by vbrazo

Loading

Zeragamba commented Aug 7, 2019 via email •

edited

Loading

Zeragamba commented Aug 13, 2019 •

edited

Loading