Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flatten SharedOptions into their Create/Update classes for auto-gen prep #1891

Merged
merged 3 commits into from Jan 3, 2020

Conversation

cjavilla-stripe
Copy link
Contributor

Mostly moving SharedOptions into their Create/Update classes and adding docstrings where they were obv missing. This seemed like a useful change in preparation of auto-gen.

r? @remi-stripe
cc @stripe/api-libraries @ob-stripe

Copy link
Contributor

@remi-stripe remi-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing all this work! Left a few nitpicky comments. Can you do them as a separate commit to help the review and then we can squash and merge

public string AccountToken { get; set; }

/// <summary>
/// Optional information related to the business.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs today say

Non-essential business information about the account


/// <summary>
/// Information about the company or business. This field is null
/// unless <c>BusinessType</c> is set to <c>company</c>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not <c> when you reference another field. Instead, it's <see cref="BusinessType"/> for example so that the IDE can reference the other field.


/// <summary>
/// Information about the person represented by the account. This field
/// is null unless <c>BusinessType</c> is set to <c>individual</c>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as earlier <see

/// Use <c>error_if_incomplete</c> if you want Stripe to return an HTTP 402 status code if
/// a subscription's first invoice cannot be paid. For example, if a payment method requires
/// 3DS authentication due to SCA regulation and further user action is needed, this
/// parameter does not create a subscription and returns an error instead. This was the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to editorialize those really long descriptions personally though for autogen it won't work
but the part about the API version is irrelevant to dotnet

@cjavilla-stripe
Copy link
Contributor Author

Pretty sure I addressed all the comments. Thanks for reviewing. ptal.

r? @remi-stripe

@remi-stripe
Copy link
Contributor

re-assigning to @ob-stripe for review before merging

@remi-stripe remi-stripe assigned ob-stripe and unassigned remi-stripe Jan 3, 2020
Copy link
Contributor

@ob-stripe ob-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cjavilla-stripe! This is much better. In hindsight SharedOptions was not such a good idea.

The PR is too large for me to be able to be 100% confident we haven't changed the public API (except for Issuing.DisputeCreateOptions where you fixed an actual issue), and I unfortunately don't know of an automated way to check, but this LGTM.

@remi-stripe remi-stripe merged commit 9f0c0ef into master Jan 3, 2020
@remi-stripe remi-stripe deleted the flatten-shared-options branch January 3, 2020 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants