in reply to Re: RFC: Swagger-codegen for Perl
in thread RFC: Swagger-codegen for Perl

another easy criticism, comments instead of pod

Replies are listed 'Best First'.
Re^3: RFC: Swagger-codegen for Perl
by wing328 (Initiate) on May 27, 2015 at 03:02 UTC
    yes, i want to use pod but didn't have cycle to do it :( if you've time, would be nice if you can submit a PR to update the comment

      yes, i want to use pod but didn't have cycle to do it :( if you've time, would be nice if you can submit a PR to update the comment

      Um, see Swagger2::POD - Convert swagger API spec to Perl documentation

      Here is more commentary

      This should not exist

      # class variables my $ua = LWP::UserAgent->new; my $http_user_agent = 'Perl-Swagger'; # HTTP user-agent my $http_timeout; #timeout my $base_url = "{{basePath}}"; sub new { my $class = shift; my %args = @_; return bless \%args, $class; } # Set the user agent of the API client # # @param string $user_agent The user agent of the API client # sub set_user_agent { my $user_agent = shift; $http_user_agent= $user_agent; }

      Don't know how critical it is to have a "set_user_agent" to maintain "Swagger" convention, but a $lwp shouldn't be a class variable, it should be an object attribute -- globals are bad mkay :)

      also, feels like too much code is being generated from templates, feels like a lot of it doesn't need to be in templates ... heard of Moose?

        IMHO, Moose is a pretty big dependency to add. All that we need here are vanilla objects. Blessed hashes are fine.

        Raisin manages to tie type information into Swagger merely with Type::Tiny. So even creating documentation doesn't need Moose.


        TGI says moo