Add documentation for async client #21

joelwurtz · 2015-10-31T17:26:23Z

dbu · 2015-10-31T17:45:45Z

docs/discovery.md

@@ -37,6 +37,30 @@ class MyClass
 }
 ```

+## HTTP Async Client Discovery
+
+This type of discovery finds installed HTTP Async Clients.


lets say "a HttpAsyncClient" instance. from the point of the user, it only finds one.

so "finds an installed HttpAsyncClient" ?

i would leave out "installed", seems obvious

I updated other lines as well to make it consistent

dbu · 2015-11-05T13:51:14Z

docs/discovery.md

@@ -19,7 +19,7 @@ composer require "php-http/discovery"

 ## HTTP Client Discovery

-This type of discovery finds installed HTTP Clients.
+This type of discovery finds a HTTPClient implementation.


not sure about writing this as HTTPClient - maybe with a space, so "HTTP client"?

same for Http Async Client (to be consistent) ?

dbu · 2015-11-06T14:56:49Z

docs/tutorial.md

+When using an asynchronous client, it will use a PSR-7 `RequestInterface` and returns a `Http\Client\Promise` :
+
+```php
+$httpAsyncClient = new HttpAsyncClientImplementation();


do we have discovery for this? should we, if we don't have currently?

We do. I think I merged it today.

then the tutorial should use it i think, instead of this line which can't be executed in reality (you would need to know your real client/adapter class name and use that instead)

joelwurtz · 2015-11-08T16:37:47Z

Despite the namespace thing is there any more thing to change for this ? poke @dbu @sagikazarmark

sagikazarmark · 2015-11-08T19:38:02Z

docs/discovery.md

@@ -19,7 +19,7 @@ composer require "php-http/discovery"

 ## HTTP Client Discovery

-This type of discovery finds installed HTTP Clients.
+This type of discovery finds a HTTP Client implementation.


aN HTTP Client

sagikazarmark · 2015-11-08T20:35:33Z

Added a few comments, which are mostly about some grammar and formatting issues. Apart from that, 👍

dbu · 2015-11-08T21:09:59Z

docs/tutorial.md

+
+This promise allows you to : 
+
+ * Add callbacks for when the response is available or an errors happens by using the then method:


the part that comes after this bullet is very long. lets maybe do an overview list and then subsections with the code examples.

Didn't catch it. You are right.

Add documentation for async client

dbu · 2015-11-09T09:28:13Z

great!

dbu reviewed Oct 31, 2015
View reviewed changes

Add document for async client

3069d34

dbu reviewed Nov 5, 2015
View reviewed changes

Add a warning box, fix typo in library name

af0befb

dbu reviewed Nov 6, 2015
View reviewed changes

Use discovery for tutorial

5c714c7

sagikazarmark reviewed Nov 8, 2015
View reviewed changes

dbu reviewed Nov 8, 2015
View reviewed changes

Fix typo and rewrite tutorial part

1ff4919

dbu added a commit that referenced this pull request Nov 9, 2015

Merge pull request #21 from joelwurtz/feature/async

ae9d39c

Add documentation for async client

dbu merged commit ae9d39c into php-http:master Nov 9, 2015


		This promise allows you to :

		* Add callbacks for when the response is available or an errors happens by using the then method:

Add documentation for async client #21

Add documentation for async client #21

Uh oh!

Conversation

joelwurtz commented Oct 31, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joelwurtz commented Nov 8, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sagikazarmark commented Nov 8, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbu commented Nov 9, 2015

Uh oh!

Uh oh!