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

docs: Adapters, how to create them #1193

Merged
merged 2 commits into from Oct 22, 2020
Merged

Conversation

olleolleolle
Copy link
Member

Description

In order to explain what it takes to make a Faraday adapter, we're adding some guide text to the page on Adapters.

It's been a while since we added the website, but now could be the time to add a little more explanation.

Todos

List any remaining work that needs to be done, i.e:

  • Proof-reading
  • Think about sections, such as the in_parallel section, is that good to be inline, or should it land in its own article?

Additional Notes

Please, add more notes as comments on this PR, we need it.


The rest of this text is about methods which make the authoring easier.

### Helpful class: `::Faraday::Adapter`
Copy link
Member

Choose a reason for hiding this comment

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

Subclassing Faraday::Adapter is also necessary to access save_response and to be recognised as an adapter by the rack builder, so I'd make that a requirement.

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.

Great work @olleolleolle 👏
I've just added a small comment and I agree with you that the parallel manager can probably be moved into another page as it's quite an advanced and long topic.

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

Successfully merging this pull request may close these issues.

None yet

2 participants