update type spec for middleware

[BenMorganIO]

Offense:

lib/tesla/middleware/tuples.ex:40: The inferred return type of call/3 ({'error',_} | {'ok',_}) has nothing in common with #{'__client__':=fun(), '__module__':=atom(), '__struct__':='Elixir.Tesla.Env', 'body':=_, 'headers':=#{binary()=>binary()}, 'method':='delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace', 'opts':=[any()], 'query':=[{atom() | binary(),binary() | [{atom() | binary(),binary() | [{_,_}]}]}], 'status':=integer(), 'url':=binary()}, which is the expected return type for the callback of the 'Elixir.Tesla.Middleware' behaviour

The return types from Tesla.Middleware was only Tesla.Env.t. However, Tesla.Middleware.Tuples was returning {:ok, Env.t} | {:error, any()}. I've updated the return spec for this. While I was doing this, I updated some of the docs; line endings and s/transations/transactions.

[teamon]

Hi again :)

I appreciate the changes but please keep them to the minimum - I am working on a 1.0 branch and I'd like to have as few merge conflicts as possible.

The Tuples middleware is a special one and this is a known type error (see #109).
I'd rather keep it as a exception and not change the Tesla.Middleware spec.

[codecov]

Codecov Report

Merging #181 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #181   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          21       21           
  Lines         421      421           
=======================================
  Hits          414      414           
  Misses          7        7

Impacted Files	Coverage Δ
lib/tesla/middleware/tuples.ex	100% <ø> (ø)	⬆️
lib/tesla.ex	100% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e2e1f4...959c7e5. Read the comment docs.

[teamon]

@BenMorganIO I'm closing this. Please take a look at 1.0 branch as it solves this issue.