📄 New docs 🎉 #1517
📄 New docs 🎉 #1517
Conversation
docs/adapters/custom/streaming.md
Outdated
| # Set a callback which will receive tuples of chunk Strings, | ||
| # the sum of characters received so far, and the response environment. | ||
| # The latter will allow access to the response status, headers and reason, as well as the request info. | ||
| req.options.on_data = Proc.new do |chunk, overall_received_bytes, env| |
There was a problem hiding this comment.
Perhaps proc { could be a shorter syntax?
There was a problem hiding this comment.
I might be wrong but I think using proc do might not behave the same way for missing parameters?
There was a problem hiding this comment.
nope, double-checked and I got confused with lambda (I can almost never remember these correctly 😂 ).
As of Ruby 1.9 (so for quite a while!!) proc has been an alias for Proc.new 👍
| require 'faraday_specs_setup' | ||
|
|
||
| RSpec.describe Faraday::Adapter::FlorpHttp do | ||
| it_behaves_like 'an adapter' |
There was a problem hiding this comment.
Just now came to think of that we could have called it a Faraday adapter.
There was a problem hiding this comment.
That would have been much smarter 🙈
Luckily, it shouldn't cause issues since this would only be loaded in faraday adapter repositories
docs/adapters/custom/testing.md
Outdated
| | `:reason_phrase_parse` | Tests that your adapter supports parsing the `reason_phrase` from the response. | | ||
| | `:compression` | Tests that your adapter can handle `gzip` and `defalte` compressions. | | ||
| | `:streaming` | Tests that your adapter supports streaming responses. See [Streaming][streaming] for more details. | | ||
| | `:parallel` | Tests that your adapter supports parallel requests. See [Parallel requests][parallel] for more details. | |
There was a problem hiding this comment.
Are these table rows sorted in any specific way?
There was a problem hiding this comment.
Not really! Open to suggestions 😄
There was a problem hiding this comment.
- in order of appearance
- in A-Z order
| Async do | ||
| Async { conn.get('/delay/3') } | ||
| Async { conn.get('/delay/3') } | ||
| end |
There was a problem hiding this comment.
@ioquatix 👋 Is this example still good?
There was a problem hiding this comment.
Yeah it's reasonable. We could always do something more elaborate but maybe that's for a separate document or part of the document?
There was a problem hiding this comment.
Perhaps a link to the adapter's repo?
Co-authored-by: Olle Jonsson <olle.jonsson@gmail.com>
Description
Introduces a new Faraday Docs website based on docsify.js 🎉