Skip to content

Document Socket client #72

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

Merged
merged 1 commit into from
Jan 5, 2016
Merged

Document Socket client #72

merged 1 commit into from
Jan 5, 2016

Conversation

ddeboer
Copy link
Contributor

@ddeboer ddeboer commented Jan 4, 2016

Usage
-----

The Socket client need a :ref:`message factory <message-factory>` in order to
Copy link
Contributor

Choose a reason for hiding this comment

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

s/need/needs/

@dbu
Copy link
Contributor

dbu commented Jan 5, 2016

👍

i think we might want a partial to include on all client docs to mention the plugin system. with a minimal client like this one, its particularly important. the client does not follow redirects for example.

@dbu
Copy link
Contributor

dbu commented Jan 5, 2016

we could add the note on plugins in the footer that talks about async and message factory (the one we said in #67 that we will separate it out later). does this client support async at all? if not, we maybe want a little table with the feature overview for each client...

@sagikazarmark
Copy link
Member

IMO all clients which support async should be implemented as async in the adapter as well, but async emulation should not be done by default.

@ddeboer ddeboer force-pushed the socket-client branch 3 times, most recently from 0ad64af to f63a23b Compare January 5, 2016 08:23
@ddeboer
Copy link
Contributor Author

ddeboer commented Jan 5, 2016

Updated according to feedback.

does this client support async at all?

No.

i think we might want a partial to include on all client docs to mention the plugin system.

Done.

@@ -0,0 +1,4 @@
* Use :ref:`plugins <plugins>` to customize the way HTTP requests are sent and responses
processed.
Copy link
Contributor

Choose a reason for hiding this comment

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

we could mention that the plain client is configured to not follow redirects for example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is that the same for all our clients or does it differ between them?

Copy link
Contributor

@dbu dbu Jan 5, 2016 via email

Choose a reason for hiding this comment

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

@dbu
Copy link
Contributor

dbu commented Jan 5, 2016

looks good. we could tweak the further reading, if you want. and it would be good to have input from joel on the remote_socket option. but both are imho not blockers for merging.

@sagikazarmark
Copy link
Member

👍

@joelwurtz
Copy link
Member

👍 except for the example :), huge thanks for taking time to do the documentation @ddeboer !

@ddeboer ddeboer force-pushed the socket-client branch 2 times, most recently from a4ccf50 to 3d122c9 Compare January 5, 2016 17:54
@ddeboer
Copy link
Contributor Author

ddeboer commented Jan 5, 2016

Tweaked further reading by giving some plugin examples.

ddeboer added a commit that referenced this pull request Jan 5, 2016
@ddeboer ddeboer merged commit 1f11fa4 into master Jan 5, 2016
@ddeboer ddeboer deleted the socket-client branch January 5, 2016 17:56
@dbu
Copy link
Contributor

dbu commented Jan 6, 2016

👍

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.

4 participants