search

pplu / aws-sdk-perl

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

Add links joining the documentation together #225

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.

When searching or browsing the documentation on metacpan its possible for the user to arrive at a piece of "sub" documentation such as Paws::DeviceFarm::CreateDevicePool, which documents arguments for calls that are actually made on the Paws::DeviceFarm service. I'd like to add a link "back" to Paws::DeviceFarm from the ::CreateDevicePool docs.

Eg changing: This class represents the parameters used for calling the method CreateDevicePool on the AWS Device Farm service. Use the attributes of this class as arguments to method CreateDevicePool. To: This class represents the parameters used for calling the method CreateDevicePool on the Paws::DeviceFarm service. Use the attributes of this class as arguments to method CreateDevicePool.

This looks like it could be achieved by amending the callclass template in Paws::API::Builder.

pplu commented 6 years ago

This would be very nice, also!

pplu commented 6 years ago

Now on release/0.37

pplu commented 6 years ago

Sorry for merging this without it passing tests appropiately.

We're getting test failures here: https://travis-ci.org/pplu/aws-sdk-perl/builds/371440836

You can see the failure at the end of https://api.travis-ci.org/v3/job/371440837/log.txt

An example of a failure that might ring a bell:

#   Failed test 'POD test for lib/Paws/Snowball/GetJobUnlockCode.pm'
#   at /home/travis/perl5/perlbrew/perls/5.26.2/lib/site_perl/5.26.2/Test/Pod.pm line 187.
# lib/Paws/Snowball/GetJobUnlockCode.pm (21): alternative text 'Amazon Import/Export Snowball' contains non-escaped | or /
castaway commented 6 years ago

Ah yes, I just found that too - "make test" isnt running author tests on my checkout (what am I missing?), so t/99_pod_syntax.t doesn't happen. It looks like we need to escape the / as E.

castaway commented 6 years ago

I've just submitted a PR to fix the pod syntax errors