Let's raise the visibility of code documentation in Ruby! What is this about?

pboling/csv_pirate

100 Pirates agree that creating CSVs is boring. Pirates prefer to be lazy. Pirates use CsvPirate. – Read the documentation

This page shows an evaluation of the documentation of pboling/csv_pirate.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
CsvPirate:: #prevent_from_failing_pre_migration
A
CsvPirate::TheCapn#buried_treasure=
A
CsvPirate::TheCapn#buried_treasure
A
CsvPirate::TheCapn#hoist_mainstay
A
CsvPirate::TheCapn#swab_poop_deck
Show 30 more ...
A
CsvPirate::TheCapn#chronometer=
A
CsvPirate::TheCapn#weigh_anchor
A
CsvPirate::TheCapn#rhumb_lines=
A
CsvPirate::TheCapn#rhumb_lines
A
CsvPirate::TheCapn#chronometer
A
CsvPirate::TheCapn#spyglasses=
A
CsvPirate::TheCapn#brigantine=
A
CsvPirate::TheCapn#astrolabe=
A
CsvPirate::TheCapn#spyglasses
A
CsvPirate::TheCapn#brigantine
A
CsvPirate::TheCapn#astrolabe
A
CsvPirate::TheCapn#pinnacle=
A
CsvPirate::TheCapn#shrouds=
A
CsvPirate::TheCapn#pinnacle
A
CsvPirate::TheCapn.parlay=
A
CsvPirate::TheCapn#shrouds
A
CsvPirate::TheCapn.parlay
A
CsvPirate::TheCapn#booty=
A
CsvPirate::TheCapn#unfurl
A
CsvPirate::TheCapn#swag=
A
CsvPirate::TheCapn#booty
A
CsvPirate::TheCapn#grub=
A
CsvPirate::TheCapn#grub
A
CsvPirate::TheCapn#swag
A
NinthBit
A
CsvPirate::TheCapn#block_and_tackle
A
CsvPirate::TheCapn#insult_swabbie
A
CsvPirate::TheCapn#traverse_board
A
CsvPirate::TheCapn#boatswain
A
CsvPirate::TheCapn#axe
Proper documentation present
B
CsvPirate::TheCapn#dig_for_treasure
B
CsvPirate::TheCapn#initialize
B
CsvPirate::TheCapn.broadside
B
CsvPirate::TheCapn#scuttle
B
CsvPirate.new
Show 13 more ...
B
CsvPirate::TheCapn.mutiny
B
CsvPirate::PirateShip::ActMethods#has_csv_pirate_ship
B
CsvPirate::PirateShip::ClassMethods#walk_the_plank
B
CsvPirate::PirateShip::ClassMethods#blindfold
B
CsvPirate::PirateShip::ClassMethods#land_ho
B
CsvPirate::TheCapn.marlinespike
B
CsvPirate::TheCapn#old_csv_dump
B
CsvPirate::TheCapn#run_through
B
CsvPirate::TheCapn#to_memory
B
CsvPirate::TheCapn#poop_deck
B
CsvPirate::TheCapn.parlance
B
CsvPirate::TheCapn.rinse
B
CsvPirate::TheCapn#binnacle
Needs work
Undocumented
U
CsvPirate
U
CsvPirate::TheCapn
U
CsvPirate::TheCapn.create
U
CsvPirate.create
U
CsvPirate::PirateShip::ClassMethods#weigh_anchor
Show 46 more ...
U
CsvPirate::PirateShip::ClassMethods#raise_anchor
U
CsvPirate::TheCapn#data_hash_from_row
U
CsvPirate::PirateShip::ClassMethods
U
CsvPirate::TheCapn#dead_mans_chest
U
CsvPirate::PirateShip::ActMethods
U
CsvPirate::TheCapn#bury_treasure=
U
CsvPirate::TheCapn#bury_treasure
U
CsvPirate::TheCapn#find_aye_arr
U
CsvPirate::TheCapn#save_object
U
CsvPirate::TheCapn#jolly_roger
U
CsvPirate::TheCapn#nocturnal=
U
CsvPirate::TheCapn#blackjack=
U
CsvPirate::TheCapn#nocturnal
U
CsvPirate::TheCapn#scrivener
U
CsvPirate::TheCapn#waggoner=
U
CsvPirate::TheCapn#blackjack
U
CsvPirate::TheCapn#send_aye
U
CsvPirate::TheCapn#swabbie=
U
CsvPirate::TheCapn#find_aye
U
CsvPirate::TheCapn#waggoner
U
CsvPirate::TheCapn#sounding
U
CsvPirate::TheCapn#maroon=
U
CsvPirate::TheCapn#gibbet=
U
CsvPirate::TheCapn#swabbie
U
CsvPirate::TheCapn#chart=
U
CsvPirate::TheCapn#gibbet
U
CsvPirate::TheCapn#maroon
U
CsvPirate::TheCapn#flies
U
CsvPirate::TheCapn#swab=
U
CsvPirate::TheCapn#chart
U
CsvPirate::TheCapn#prize
U
CsvPirate::TheCapn#swab
U
CsvPirate::TheCapn#aft=
U
CsvPirate::TheCapn#mop=
U
CsvPirate::TheCapn#mop
U
CsvPirate::TheCapn#aft
U
CsvPirate::PirateShip::ClassMethods#get_chronometer
U
CsvPirate::PirateShip::ClassMethods#piratey_args
U
CsvPirate::TheCapn#northwest_passage
U
CsvPirate::TheCapn#merchantman
U
CsvPirate::TheCapn#north_pole
U
CsvPirate::TheCapn#filibuster
U
CsvPirate::TheCapn#sand_glass
U
CsvPirate::TheCapn#analemma
U
CsvPirate::TheCapn#coxswain
U
CsvPirate::TheCapn#lantern

Let's raise the visibility of documentation in Ruby!

This page is for pboling/csv_pirate and is part of a project called "Inch Pages", showing documentation measurements provided by Inch. Inch Pages also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.

Fork me on GitHub