Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Yard powered docs #1553
Yard powered docs #1553
Conversation
|
forgot to actually open this PR for #1330 |
|
Can CONTRIBUTING.md be updated with guidelines on how this should be used going forward? |
|
Updated contributing, and added some sample documentation to Faker::Alphanumeric, Faker::Book, and Faker::Books's subclasses. |
|
|
vbrazo
force-pushed the
faker-ruby:master
branch
3 times, most recently
from
69291b2
to
5cc660c
|
@Zeragamba can you update this branch with master? We'll move on with these changes for v3. |
|
Sure!
Edit: remove email spam
|
|
Looks good to me! |
|
Also, you should probably add |
|
For the # @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. |
|
I do prefer the latter style, @connorshea |
|
I think I've updated all of them now, that wasn't as hard as I expected. Zeragamba#6 |
|
@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. |
|
@connorshea Sounds good. Left a few change requests there, I'll merge those in when one of us get the time to fix it. :) |
|
Lots of new docs from @connorshea so this is ready for re-review |
|
There are some new conflicts now. |
Some of the Elder Scrolls methods were added after others, in 1.9.0.
Zeragamba
force-pushed the
Zeragamba:yard-powered-docs
branch
2 times, most recently
from
100a035
to
8cfb1fc
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
|
live example of these docs: https://rubydoc.info/github/SpyMaster356/faker/master/Faker/Avatar |
|
LGTM |
|
|
|
It merged! Woooo :party: |
|
|
* 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
Closes #1330