Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Correctly configure yard and fix the :row_header docs.

  • Loading branch information...
commit 15cdf4e1947868d7dffd126056c62c163b947629 1 parent 5e001e6
@pupeno pupeno authored
View
2  .gitignore
@@ -3,3 +3,5 @@
.bundle
Gemfile.lock
pkg/*
+.yardoc
+doc
View
1  .yardopts
@@ -0,0 +1 @@
+--markup markdown lib/**/*.rb
View
8 README.rdoc
@@ -140,6 +140,14 @@ Inside your Gemfile:
gem 'table_builder', '0.0.3', :git => 'git://github.com/jchunky/table_builder.git'
+== Contributing
+
+Document any new options and verify the documentation looks correct by running:
+
+ yard server --reload
+
+and going to http://localhos:8808
+
== Contributors
Thanks to Petrik de Heus and Sean Dague.
View
9 lib/table_builder/calendar_helper.rb
@@ -1,13 +1,14 @@
module CalendarHelper
# Generates a calendar (as a table) for an array of objects placing each of them on the corresponding date.
#
- # TODO: fully document this method, the current documentation is far from done.
+ # **TODO: fully document this method, the current documentation is far from done.**
#
# @param [Hash] options extra options
+ #
# :row_header if true, each row will have an extra cell at the beginning, as a row header. A typical usage would be
- # to output week numbers. When the block is called, it will get the date that would normally be passed to the
- # first day of the week (to give you some context) and a nil list of objects (and that's how you recognize it as
- # a header, because empty days get an empty array, not nil).
+ # to output week numbers. When the block is called, it will get the date that would normally be passed to the
+ # first day of the week (to give you some context) and a nil list of objects (and that's how you recognize it as
+ # a header, because empty days get an empty array, not nil).
def calendar_for(objects, *args, &block)
raise ArgumentError, "Missing block" unless block_given?
options = args.last.is_a?(Hash) ? args.pop : {}
View
1  table_builder.gemspec
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
# specify any dependencies here; for example:
# s.add_development_dependency "rspec"
# s.add_runtime_dependency "rest-client"
+ s.add_development_dependency "yard"
end

0 comments on commit 15cdf4e

Please sign in to comment.
Something went wrong with that request. Please try again.