search

plu / Pithub

Perl Github v3 API
http://metacpan.org/module/Pithub
Other
68 stars 36 forks source link

Need more examples in the SYNOPSIS of main module #188

Closed zoffixznet closed 8 years ago

zoffixznet commented 8 years ago

It took me browsing through a ton of modules, writing a semi-negative review, then accidentally stumbling on Pithub::Base (and deleting the review) before I realized that I actually do NOT have to set user/repo on each submodule and that there is a token attribute that takes an OAuth token.

I think even if the Pithub's synopsis had this extra bit of sample code, it'd save users a lot of confusion and frustration:

my $pit = Pithub->new(
  user  => $user,
  repo  => $repo,
  token => $oauth_token,
);

$pit->repos->get;
$pit->repos->commits->list;

P.S.: it'd also be interesting to know why the dist is called "Pithub". Perhaps an ABOUT section in the pod could cover that.

oalders commented 8 years ago

We'd accept a pull request for this. BTW, Perl + Github = Pithub. I initially thought it was PLU + Github but @plu set me straight on that point. :)