From 06db67210cd527612d4b80c2ccde92e05e9ac09d Mon Sep 17 00:00:00 2001 From: Dave Baird Date: Tue, 10 Nov 2015 14:50:22 +0100 Subject: [PATCH] Tiny doc tweak --- .../src/main/resources/perl/README.md | 15 ++++++++------- .../src/main/resources/perl/Role.mustache | 15 ++++++++------- samples/client/petstore/perl/README.md | 15 ++++++++------- .../petstore/perl/lib/WWW/SwaggerClient/Role.pm | 15 ++++++++------- 4 files changed, 32 insertions(+), 28 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/perl/README.md b/modules/swagger-codegen/src/main/resources/perl/README.md index 16df3de6217..7603c39f07a 100644 --- a/modules/swagger-codegen/src/main/resources/perl/README.md +++ b/modules/swagger-codegen/src/main/resources/perl/README.md @@ -148,10 +148,10 @@ Returns an API factory object. You probably won't need to call this directly. # MISSING METHODS -Most of the methods on the API are delegated to individual sub-API objects (e.g. -Pet API, Store API, User API etc). Where different sub-APIs use the same method -name (e.g. `new()`), these methods can't be delegated. So you need to call -`$api->pet_api->new()`. +Most of the methods on the API are delegated to individual endpoint API objects +(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the +same method name (e.g. `new()`), these methods can't be delegated. So you need +to call `$api->pet_api->new()`. In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's @@ -161,9 +161,10 @@ unlikely in general that any methods will be undelegatable, except for: class_documentation() method_documentation() -To call these methods, you need to get a handle on the relevant object, either -by calling `$api->foo_api` or by retrieving an object, e.g. -`$api->get_pet_by_id(pet_id => $pet_id)`. +To call these methods, you need to get a handle on the relevant object, either +by calling `$api->foo_api` or by retrieving an object, e.g. +`$api->get_pet_by_id(pet_id => $pet_id)`. They are class methods, so +you could also call them on class names. # BUILDING YOUR LIBRARY diff --git a/modules/swagger-codegen/src/main/resources/perl/Role.mustache b/modules/swagger-codegen/src/main/resources/perl/Role.mustache index 4ece1bd092e..41a6de7ff36 100644 --- a/modules/swagger-codegen/src/main/resources/perl/Role.mustache +++ b/modules/swagger-codegen/src/main/resources/perl/Role.mustache @@ -226,10 +226,10 @@ Returns an API factory object. You probably won't need to call this directly. =head1 MISSING METHODS -Most of the methods on the API are delegated to individual sub-API objects (e.g. -Pet API, Store API, User API etc). Where different sub-APIs use the same method -name (e.g. C), these methods can't be delegated. So you need to call -C<$api-Epet_api-Enew()>. +Most of the methods on the API are delegated to individual endpoint API objects +(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the +same method name (e.g. C), these methods can't be delegated. So you need +to call C<$api-Epet_api-Enew()>. In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's @@ -239,9 +239,10 @@ unlikely in general that any methods will be undelegatable, except for: class_documentation() method_documentation() -To call these methods, you need to get a handle on the relevant object, either -by calling C<$api-Efoo_api> or by retrieving an object, e.g. -C<$api-Eget_pet_by_id(pet_id =E $pet_id)>. +To call these methods, you need to get a handle on the relevant object, either +by calling C<$api-Efoo_api> or by retrieving an object, e.g. +C<$api-Eget_pet_by_id(pet_id =E $pet_id)>. They are class methods, so +you could also call them on class names. =head1 BUILDING YOUR LIBRARY diff --git a/samples/client/petstore/perl/README.md b/samples/client/petstore/perl/README.md index 1e0091fcc6b..d436e81c292 100644 --- a/samples/client/petstore/perl/README.md +++ b/samples/client/petstore/perl/README.md @@ -148,10 +148,10 @@ Returns an API factory object. You probably won't need to call this directly. # MISSING METHODS -Most of the methods on the API are delegated to individual sub-API objects (e.g. -Pet API, Store API, User API etc). Where different sub-APIs use the same method -name (e.g. `new()`), these methods can't be delegated. So you need to call -`$api->pet_api->new()`. +Most of the methods on the API are delegated to individual endpoint API objects +(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the +same method name (e.g. `new()`), these methods can't be delegated. So you need +to call `$api->pet_api->new()`. In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's @@ -161,9 +161,10 @@ unlikely in general that any methods will be undelegatable, except for: class_documentation() method_documentation() -To call these methods, you need to get a handle on the relevant object, either -by calling `$api->foo_api` or by retrieving an object, e.g. -`$api->get_pet_by_id(pet_id => $pet_id)`. +To call these methods, you need to get a handle on the relevant object, either +by calling `$api->foo_api` or by retrieving an object, e.g. +`$api->get_pet_by_id(pet_id => $pet_id)`. They are class methods, so +you could also call them on class names. # BUILDING YOUR LIBRARY diff --git a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm index b66a6bd2e27..51d477f9954 100644 --- a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm +++ b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm @@ -226,10 +226,10 @@ Returns an API factory object. You probably won't need to call this directly. =head1 MISSING METHODS -Most of the methods on the API are delegated to individual sub-API objects (e.g. -Pet API, Store API, User API etc). Where different sub-APIs use the same method -name (e.g. C), these methods can't be delegated. So you need to call -C<$api-Epet_api-Enew()>. +Most of the methods on the API are delegated to individual endpoint API objects +(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the +same method name (e.g. C), these methods can't be delegated. So you need +to call C<$api-Epet_api-Enew()>. In principle, every API is susceptible to the presence of a few, random, undelegatable method names. In practice, because of the way method names are constructed, it's @@ -239,9 +239,10 @@ unlikely in general that any methods will be undelegatable, except for: class_documentation() method_documentation() -To call these methods, you need to get a handle on the relevant object, either -by calling C<$api-Efoo_api> or by retrieving an object, e.g. -C<$api-Eget_pet_by_id(pet_id =E $pet_id)>. +To call these methods, you need to get a handle on the relevant object, either +by calling C<$api-Efoo_api> or by retrieving an object, e.g. +C<$api-Eget_pet_by_id(pet_id =E $pet_id)>. They are class methods, so +you could also call them on class names. =head1 BUILDING YOUR LIBRARY