Add documentation, change to named parameters to all functions, update tests and add example code. #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation to all methods. Change tests as appropriate to match the new method signatures.
rustyconover
added a commit
that referenced
this pull request
Apr 26, 2014
Add documentation, change to named parameters to all functions, update tests and add example code. Changed all functions to use named parameters to follow the Stripe API. This will break some existing code that relied on positional parameters. See the documentation for changes and new examples of calling functions. One example get_invoice() you now must pass get_invoice(invoice_id => $id) where you previously called get_invoice($id). I think named parameters allow more flexibility and expressiveness. Added documentation of each function along with an example call of that function to the POD documentation. Described all method's accepted parameters and types. Changed to using MooseX::Method::Signatures rather than method module to remove some older dependencies and add better type checking to parameters. Reworked live.t to reflect the API changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed all functions to use named parameters to follow the Stripe API. This will break some existing code that relied on positional parameters. See the documentation for changes and new examples of calling functions. One example get_invoice() you now must pass get_invoice(invoice_id => $id) where you previously called get_invoice($id). I think named parameters allow more flexibility and expressiveness.
Added documentation of each function along with an example call of that function to the POD documentation.
Described all method's accepted parameters and types.
Changed to using MooseX::Method::Signatures rather than method module to remove some older dependencies and add better type checking to parameters.
Reworked live.t to reflect the API changes.