search

evanphx / benchmark-ips

Provides iteration per second benchmarking for Ruby
MIT License
1.72k stars 97 forks source link

Add Documentations. #16

Closed JuanitoFatas closed 9 years ago

JuanitoFatas commented 10 years ago

Hello. I add more documents (yard) throughout the project.

@davy Could you please take a look that will these changes break anything you're using? Thanks.

Code changes:

I found unused helpers module (Removed in bc44856) and one unused method: as_action? (Removed in 57c6c61). Also I update STDOUT to $stdout (921da62) to make it more consistent.

I have found two incorrect documentations. But could not solve it.

Benchmark::IPS::Report and Benchmark::IPS::Job has incorrect documentations in instance variable (attr_reader):

Benchmark::IPS::Job incorrect instance variable document:

screenshot 2014-06-20 12 10 25

Relevant changes: https://github.com/JuanitoFatas/benchmark-ips/blob/8c0c32148f4c95bd0e787bd4e0cfcc325ebe61f3/lib/benchmark/ips/job.rb#L4-L15

The descriptions is wrong: class Benchmark::IPS::Job..

Benchmark::IPS::Job incorrect instance variable document:

screenshot 2014-06-20 12 11 00

Relevant changes: https://github.com/JuanitoFatas/benchmark-ips/blob/6df96fedbef199d16f15e2a1329d620ed2a9ab5a/lib/benchmark/ips/report.rb#L8-L9

The descriptions is wrong: class Benchmark::IPS::Report..

davy commented 10 years ago

Took a quick look and didn't see any issues on my end! Thanks, I was hoping to find some time to add documentation, but this is thorough and amazing! :smiley_cat:

evanphx commented 9 years ago

This looks great! Sorry for now merging it earlier!

JuanitoFatas commented 9 years ago

:yellow_heart: :blue_heart: :green_heart: :heart: :purple_heart: