Skip to content
Snippets Groups Projects
Commit fd8b6237 authored by Anton Soldatov's avatar Anton Soldatov
Browse files

Updates in documentation and comments

parent 57d112c5
No related branches found
No related tags found
No related merge requests found
redminer # redminer
Automating RedMine (http://www.redmine.org) with Perl. Automating routine [RedMine](http://www.redmine.org) tasks with Perl 5.10+.
The script is equipped with an in-place RedMiner::API wrapper for RedMine REST API (http://www.redmine.org/projects/redmine/wiki/Rest_api). Currently the project consists of two parts:
New calls and commands are supposed to be added on demand. 1. `redminer` script itself. For now it supports only creating projects with subprojects
from a given layout, but in the future it's aimed for various RedMine automation tasks
2. `RedMiner::API` module, a Perl binding to [RedMine REST API](http://www.redmine.org/projects/redmine/wiki/Rest_api).
Please refer to [built-in POD documentation](../blob/master/lib/RedMiner/API.pm) for more details
Dependencies ## Non-core Dependencies
* Perl 5.10+ 1. [LWP::UserAgent](https://metacpan.org/pod/LWP::UserAgent)
* Config::IniFiles 2. [URI](https://metacpan.org/pod/URI)
* LWP::UserAgent 3. [URI::QueryParam](https://metacpan.org/pod/URI::QueryParam)
* JSON::XS 4. [JSON::XS](https://metacpan.org/pod/JSON::XS)
5. [Config::IniFiles](https://metacpan.org/pod/Config::IniFiles) (`redminer` only)
...@@ -454,7 +454,7 @@ sub _normalize_objects ...@@ -454,7 +454,7 @@ sub _normalize_objects
my $objects = shift; my $objects = shift;
$objects = ucfirst $objects; $objects = ucfirst $objects;
# These are token that for a *single* entry in the resulting request path, # These are tokens that form a *single* entry in the resulting request path,
# e.g.: PUT /time_entries/1.json # e.g.: PUT /time_entries/1.json
# But it is natural to spell them like this: # But it is natural to spell them like this:
# $api->updateTimeEntry(1, { ... }); # $api->updateTimeEntry(1, { ... });
...@@ -479,7 +479,7 @@ sub _object ...@@ -479,7 +479,7 @@ sub _object
return $object; return $object;
} }
# If an object is singular, pluralize to make its category name: user -> users # If an object is singular, pluralize it to make its category name: user -> users
sub _category sub _category
{ {
my $self = shift; my $self = shift;
...@@ -521,6 +521,8 @@ dispatch a single method name without using chains of interrim objects as Redmin ...@@ -521,6 +521,8 @@ dispatch a single method name without using chains of interrim objects as Redmin
=back =back
Fork this project on GitHub: https://github.com/igelhaus/redminer
=head1 AUTHOR =head1 AUTHOR
Anton Soldatov, E<lt>igelhaus@gmail.comE<gt> Anton Soldatov, E<lt>igelhaus@gmail.comE<gt>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment