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

update multipart docs to mention ParamPart class #1018

Merged
merged 5 commits into from
Sep 20, 2019

Conversation

technoweenie
Copy link
Member

@technoweenie technoweenie commented Sep 11, 2019

This updates the multipart documentation on the site. It was rewritten to include ParamsPart from #1017, while providing other important details and example usage.

  • Await final class names for Faraday::UploadIO and Faraday::ParamsPart before merging

iMacTia
iMacTia previously approved these changes Sep 13, 2019
Copy link
Member

@iMacTia iMacTia left a comment

Choose a reason for hiding this comment

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

Clear and detailed 👍

@jeremyisr
Copy link
Contributor

Hi @technoweenie, I see you updated the documentation. Were you expecting me to add an alias to ::UploadIO from ::Faraday::FilePart ?

@technoweenie
Copy link
Member Author

@jeremy-israel Not at all! I started on the docs so I could see the new class names in action.

@technoweenie
Copy link
Member Author

I updated this to use the latest class names from #1017 and #1021.

@olleolleolle olleolleolle changed the title update multipart docs to mention ParamsPart class update multipart docs to mention ParamPart class Sep 19, 2019
olleolleolle
olleolleolle previously approved these changes Sep 19, 2019
Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

This explains the new name for the renamed class, and also includes when ParamPart was introduced.

Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

Things documentation update brings clarity about the current (better) names.

@technoweenie
Copy link
Member Author

Thanks for approving this so much! I'll try to use Draft PRs in the future :)

@technoweenie technoweenie merged commit 80ba52c into master Sep 20, 2019
@technoweenie technoweenie deleted the multipart-docs-update branch September 20, 2019 11:09
@olleolleolle
Copy link
Member

Vigorous and enthusiastic approval is the best approval!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants