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

Enable XML documentation #1280

Merged
merged 1 commit into from
Sep 11, 2018
Merged

Enable XML documentation #1280

merged 1 commit into from
Sep 11, 2018

Conversation

ob-stripe
Copy link
Contributor

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

Generates the XML documentation file. Even though few of our classes are properly documented, it's better than nothing.

Partially fixes #1261.

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.

How did you test/confirm this change will do what you expect? also added some minor comments

@ob-stripe
Copy link
Contributor Author

How did you test/confirm this change will do what you expect?

I verified that building the project generates a Stripe.net.xml file with the documentation. I assume that the file will automatically be included next time we push a version to NuGet, but that's unfortunately hard to test in advance.

@remi-stripe
Copy link
Contributor

Gotcha, I think that makes sense, approving!

@ob-stripe ob-stripe merged commit f897b79 into master Sep 11, 2018
@ob-stripe ob-stripe deleted the ob-gerate-doc-file branch September 11, 2018 14:47
@ob-stripe
Copy link
Contributor Author

Released in 19.6.0.

@xt0rted
Copy link
Contributor

xt0rted commented Sep 11, 2018

Confirming this is showing in the NuGet package now.

19.5.0

image

19.6.0

image

@xt0rted
Copy link
Contributor

xt0rted commented Sep 11, 2018

I assume that the file will automatically be included next time we push a version to NuGet, but that's unfortunately hard to test in advance.

You can open the NuGet package from the CI build with NuGet Package Explorer if you ever need to test things like that.

@ob-stripe
Copy link
Contributor Author

\o/ Awesome, thanks @xt0rted!

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.

No code comment or docs in lib
3 participants