search

pplu / aws-sdk-perl

A community AWS SDK for Perl Programmers
Other
170 stars 94 forks source link

Use the examples-1.json in botocore to create better example code #227

Closed castaway closed 6 years ago

castaway commented 6 years ago

I'm being sponsored by ZipRecruiter to have a go at improving some of the Paws generated documentation. This is one of the items on my list.

The botocore source code contains, for about half of the services, an examples-1.json file containining examples for the API methods. I'd like to translate these examples into synopses for the appropriate call class documentation where they exist.

It looks like this could be achieved by adding attributes to Paws::API::Builder for the examples.json filename and its contents, and constructing the examples in the callclass template.

pplu commented 6 years ago

Looks good!

pplu commented 6 years ago

Paws 0.37 with this change has just been uploaded to CPAN