Finish inline property docs #321
Merged
Conversation
This file contains 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
drewish
reviewed
Jul 14, 2017
lib/recurly/account_balance.php
Outdated
| @@ -1,5 +1,11 @@ | |||
| <?php | |||
|
|
|||
| /** | |||
| * Class Recurly_AccountBalance | |||
| * @property Recurly_Stub $account The associated Recurly_Account for this acquisition object. | |||
lib/recurly/account_acquisition.php
Outdated
| @@ -1,5 +1,16 @@ | |||
| <?php | |||
|
|
|||
| /** | |||
| * Class Recurly_AccountAcquisition | |||
| * @property Recurly_Stub $account The associated Recurly_Account for this acquisition object. | |||
There was a problem hiding this comment.
We refer to this object as "acquisition object", "account acquisition", "account acquisition info" can we just pick one and use it consistently?
lib/recurly/addon.php
Outdated
| * @property string $name The add-on name. Max of 255 characters. | ||
| * @property int $default_quantity Default quantity for the hosted pages, defaults to 1. | ||
| * @property int $default_quantity_on_hosted_page If true, displays a quantity field on the hosted pages for the add-on. | ||
| * @property string $tax_code Optional field for EU VAT merchants and Avalara AvaTax Pro merchants. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own AvaTax account configured, you can use Avalara's tax codes to assign custom tax rules. |
There was a problem hiding this comment.
We've got a few styles of listing to valid enum values:
Allowed values: [referral,...values of 'unknown', 'physical',...is Fixed-Price (fixed), or Usage-Based (usage)
It would be nice to standardize it a bit. Are we going to quote the values? etc
lib/recurly/addon.php
Outdated
| * @property float $usage_percentage If add_on_type = usage, you will see usage_percentage, which can have a value if usage_type = percentage. Must be between 0.0000 and 100.0000. | ||
| * @property string $revenue_schedule_type Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan should be recognized. When creating a Plan, if you supply an end_date and end_date available schedule types are never, evenly, at_range_start, or at_range_end. | ||
| * @property DateTime $created_at The date and time the addon was created. | ||
| * @property DateTime $updated_at The date and time the addon or its billing info was last updated. |
There was a problem hiding this comment.
its billing info seems like copy pasta.
lib/recurly/addon.php
Outdated
| * @property string $usage_type string If add_on_type = usage, you will see usage_type, which can be price or percentage. If price, the price is defined in unit_amount_in_cents. If percentage, the percentage is defined in usage_percentage. | ||
| * @property float $usage_percentage If add_on_type = usage, you will see usage_percentage, which can have a value if usage_type = percentage. Must be between 0.0000 and 100.0000. | ||
| * @property string $revenue_schedule_type Optional field for setting a revenue schedule type. This will determine how revenue for the associated Plan should be recognized. When creating a Plan, if you supply an end_date and end_date available schedule types are never, evenly, at_range_start, or at_range_end. | ||
| * @property DateTime $created_at The date and time the addon was created. |
There was a problem hiding this comment.
Typically we use the hyphen in "add-on".
lib/recurly/redemption.php
Outdated
| * @property Recurly_Stub $account The URL of account belonging to this redemption. | ||
| * @property Recurly_Stub $subscription The URL of subscription belonging to this redemption. | ||
| * @property string $uuid The unique UUID referencing this redemption. | ||
| * @property boolean $single_use True if this is a single_use coupon. |
There was a problem hiding this comment.
Can we make this "a single use coupon."
lib/recurly/redemption.php
Outdated
| * @property Recurly_Stub $subscription The URL of subscription belonging to this redemption. | ||
| * @property string $uuid The unique UUID referencing this redemption. | ||
| * @property boolean $single_use True if this is a single_use coupon. | ||
| * @property integer $total_discounted_in_cents Total in cents for the discount issued with this redemption |
There was a problem hiding this comment.
Nit but all the other properties end with a period
lib/recurly/subscription_addon.php
Outdated
| @@ -1,5 +1,14 @@ | |||
| <?php | |||
|
|
|||
| /** | |||
| * Class Recurly_SubscriptionAddOn | |||
| * @property Recurly_Stub $gift_card The gift card object is required in order to redeem a redemption code. | |||
There was a problem hiding this comment.
Is this really on the subscription add-on?
lib/recurly/subscription_addon.php
Outdated
| * Class Recurly_SubscriptionAddOn | ||
| * @property Recurly_Stub $gift_card The gift card object is required in order to redeem a redemption code. | ||
| * @property string $add_on_code The code for the Add-On. | ||
| * @property int $unit_amount_in_cents Amount of the transaction in cents. Max 10000000. |
There was a problem hiding this comment.
not sure transaction is the right word here
lib/recurly/usage.php
Outdated
| @@ -1,5 +1,19 @@ | |||
| <?php | |||
|
|
|||
| /** | |||
| * Class Recurly_Usage | |||
| * @property Recurly_Stub $measured_unit The url to the Recurly_MeasuredUnit associated with this usage. | |||
There was a problem hiding this comment.
You capitalized all the other URLs so lets have this one match
bhelx
force-pushed
the
finish_property_docs
branch
from
3faebaf
to
ccc7fa6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Continuing on the work of @phpdave to document the resource properties in #279.