diff options
| author | Zack Hobson | 2013-11-21 14:52:11 -0800 |
|---|---|---|
| committer | Zack Hobson | 2013-11-21 14:52:11 -0800 |
| commit | f0f2c7e2954d061079ed51cb6c4ce98e5b3f4127 (patch) | |
| tree | f51e83e2a9ca32d6881a801648543bf3496c3071 | |
| parent | 4e755f701276b154bc3553e32ea45f5236a1e668 (diff) | |
| download | hcl-f0f2c7e2954d061079ed51cb6c4ce98e5b3f4127.tar.bz2 | |
Documentation improvements.
| -rw-r--r-- | .document | 2 | ||||
| -rw-r--r-- | HACKING.markdown | 6 | ||||
| -rw-r--r-- | Rakefile | 5 | ||||
| -rw-r--r-- | lib/hcl/app.rb | 5 |
4 files changed, 13 insertions, 5 deletions
@@ -1 +1 @@ ---files CHANGELOG +- CHANGELOG HACKING.markdown diff --git a/HACKING.markdown b/HACKING.markdown index a2066b8..b158189 100644 --- a/HACKING.markdown +++ b/HACKING.markdown @@ -14,3 +14,9 @@ To run HCl in place (e.g. for testing out local changes) you can use bundle exec bundle exec bin/hcl +## Generating API documentation + +To generate and view the API documentation: + + rake doc + open doc/index.html @@ -9,7 +9,6 @@ end task :default => :test require 'yard' -YARD::Rake::YardocTask.new do |t| - t.options = %w[--files CHANGELOG] -end +YARD::Rake::YardocTask.new +task :doc => :yard diff --git a/lib/hcl/app.rb b/lib/hcl/app.rb index c86e3c5..970bd6d 100644 --- a/lib/hcl/app.rb +++ b/lib/hcl/app.rb @@ -87,12 +87,15 @@ Commands: # start a task using an alias hcl [start] @<task_alias> [+<time>] [<message>] - # add a line to your running timer + # add a line to a running timer hcl note <message> # stop a running timer hcl stop [<message>] + # log a task and time without leaving a timer running + hcl log @<task_alias> [+<time>] [<message>] + # resume the last stopped timer or a specific task hcl resume [@<task_alias>] |