[Bps-public-commit] r9728 - in Net-Hiveminder: lib/Net
sartak at bestpractical.com
sartak at bestpractical.com
Wed Nov 21 22:21:57 EST 2007
Author: sartak
Date: Wed Nov 21 22:21:56 2007
New Revision: 9728
Modified:
Net-Hiveminder/ (props changed)
Net-Hiveminder/README
Net-Hiveminder/lib/Net/Hiveminder.pm
Log:
r45526 at onn: sartak | 2007-11-21 22:21:48 -0500
Doc updates, fix my email addy
Modified: Net-Hiveminder/README
==============================================================================
--- Net-Hiveminder/README (original)
+++ Net-Hiveminder/README Wed Nov 21 22:21:56 2007
@@ -20,54 +20,60 @@
documentation for the lower-level interface.
display_tasks TASKS
- This will take a list of hash references (tasks) and convert them to
+ This will take a list of hash references, "TASKS", and convert each to a
human-readable form.
- In scalar context it will return the tasks joined by newlines.
+ In scalar context it will return the readable forms of these tasks
+ joined by newlines.
get_tasks ARGS
- Runs a search (with ARGS) for tasks. There are no defaults here, so this
+ Runs a search with "ARGS" for tasks. There are no defaults here, so this
can be used for anything.
+ Returns a list of hash references, each one being a task. Use
+ "display_tasks" if necessary.
+
todo_tasks [ARGS]
Returns a list of hash references, each one a task. This uses the same
- query that the home page of Hiveminder uses.
+ query that the home page of Hiveminder uses. The optional "ARGS" will be
+ passed as well so you can narrow down your todo list.
todo [ARGS]
- Returns a list of tasks in human-readable form. Additional arguments
- will be included in the search.
+ Returns a list of tasks in human-readable form. The optional "ARGS" will
+ be passed as well so you can narrow down your todo list.
In scalar context it will return the concatenation of the tasks.
create_task SUMMARY
- Creates a new task with the given summary.
+ Creates a new task with "SUMMARY".
- read_task Locator
- Load a task with the given record locator.
+ read_task LOCATOR
+ Load task "LOCATOR".
- update_task Locator, Args
- Takes a record locator and uses it to update that task with Args.
+ update_task lOCATOR, ARGS
+ Update task "LOCATOR" with "ARGS".
- delete_task Locator
- Takes a record locator and uses it to delete that task.
+ delete_task LOCATOR
+ Delete task "LOCATOR".
- braindump Text[, Tokens]
- Braindumps the given text. You may also pass a string of tokens to give
- defaults to each of the braindumped tasks.
+ braindump TEXT[, TOKENS]
+ Braindumps "TEXT". "TOKENS" may be used to provide default attributes to
+ all the braindumped tasks (this is part of what the filter feature of
+ Hiveminder's IM bot does).
- email_of id
- Take a user ID and retrieve that user's email address.
+ email_of ID
+ Retrieve user "ID"'s email address.
- canonicalize_priority priority
+ canonicalize_priority PRIORITY
Attempts to understand a variety of different priority formats and
- change it to the standard 1-5. This will "confess" if it doesn't
- understand the priority.
+ change "PRIORITY" to the standard 1-5. This will "confess" if it doesn't
+ understand "PRIORITY".
SEE ALSO
Jifty, Net::Jifty
AUTHOR
- Shawn M Moore, "<sartak at gmail.com>"
+ Shawn M Moore, "<sartak at bestpractical.com>"
BUGS
Please report any bugs or feature requests to "bug-net-hiveminder at
Modified: Net-Hiveminder/lib/Net/Hiveminder.pm
==============================================================================
--- Net-Hiveminder/lib/Net/Hiveminder.pm (original)
+++ Net-Hiveminder/lib/Net/Hiveminder.pm Wed Nov 21 22:21:56 2007
@@ -55,10 +55,11 @@
=head2 display_tasks TASKS
-This will take a list of hash references (tasks) and convert them to
+This will take a list of hash references, C<TASKS>, and convert each to a
human-readable form.
-In scalar context it will return the tasks joined by newlines.
+In scalar context it will return the readable forms of these tasks joined by
+newlines.
=cut
@@ -111,9 +112,12 @@
=head2 get_tasks ARGS
-Runs a search (with ARGS) for tasks. There are no defaults here, so this can
+Runs a search with C<ARGS> for tasks. There are no defaults here, so this can
be used for anything.
+Returns a list of hash references, each one being a task. Use C<display_tasks>
+if necessary.
+
=cut
sub get_tasks {
@@ -124,7 +128,8 @@
=head2 todo_tasks [ARGS]
Returns a list of hash references, each one a task. This uses the same query
-that the home page of Hiveminder uses.
+that the home page of Hiveminder uses. The optional C<ARGS> will be passed as
+well so you can narrow down your todo list.
=cut
@@ -146,8 +151,8 @@
=head2 todo [ARGS]
-Returns a list of tasks in human-readable form. Additional arguments will be
-included in the search.
+Returns a list of tasks in human-readable form. The optional C<ARGS> will be
+passed as well so you can narrow down your todo list.
In scalar context it will return the concatenation of the tasks.
@@ -161,7 +166,7 @@
=head2 create_task SUMMARY
-Creates a new task with the given summary.
+Creates a new task with C<SUMMARY>.
=cut
@@ -172,9 +177,9 @@
$self->create(Task => summary => $summary);
}
-=head2 read_task Locator
+=head2 read_task LOCATOR
-Load a task with the given record locator.
+Load task C<LOCATOR>.
=cut
@@ -186,9 +191,9 @@
return $self->read(Task => id => $id);
}
-=head2 update_task Locator, Args
+=head2 update_task lOCATOR, ARGS
-Takes a record locator and uses it to update that task with Args.
+Update task C<LOCATOR> with C<ARGS>.
=cut
@@ -200,9 +205,9 @@
return $self->update(Task => id => $id, @_);
}
-=head2 delete_task Locator
+=head2 delete_task LOCATOR
-Takes a record locator and uses it to delete that task.
+Delete task C<LOCATOR>.
=cut
@@ -214,10 +219,11 @@
return $self->delete(Task => id => $id);
}
-=head2 braindump Text[, Tokens]
+=head2 braindump TEXT[, TOKENS]
-Braindumps the given text. You may also pass a string of tokens to give
-defaults to each of the braindumped tasks.
+Braindumps C<TEXT>. C<TOKENS> may be used to provide default attributes to all
+the braindumped tasks (this is part of what the filter feature of Hiveminder's
+IM bot does).
=cut
@@ -230,9 +236,9 @@
->{message};
}
-=head2 email_of id
+=head2 email_of ID
-Take a user ID and retrieve that user's email address.
+Retrieve user C<ID>'s email address.
=cut
@@ -246,11 +252,11 @@
return $user->{email};
}
-=head2 canonicalize_priority priority
+=head2 canonicalize_priority PRIORITY
-Attempts to understand a variety of different priority formats and change it
-to the standard 1-5. This will C<confess> if it doesn't understand the
-priority.
+Attempts to understand a variety of different priority formats and change
+C<PRIORITY> to the standard 1-5. This will C<confess> if it doesn't understand
+C<PRIORITY>.
=cut
@@ -286,7 +292,7 @@
=head1 AUTHOR
-Shawn M Moore, C<< <sartak at gmail.com> >>
+Shawn M Moore, C<< <sartak at bestpractical.com> >>
=head1 BUGS
More information about the Bps-public-commit
mailing list