-
Notifications
You must be signed in to change notification settings - Fork 56
add documentation for retry and redirect plugins, split building own, document library usage #87
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
Conversation
@@ -1,5 +1,3 @@ | |||
.. _client-common: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i propose we stop using labels for whole doc chapters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't really know why or why not, so fine with me :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess he means using doc reference instead. Am I right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
with a label like this, you write :ref:
client-common. but to specify a whole chapter, you can do
:doc:`/path/to/client-common```. i would only use labels when we want to deep link to specific sections.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, ok, got it.
4c3439b
to
14d316f
Compare
@@ -15,7 +15,7 @@ To install the cURL client, run: | |||
Usage | |||
----- | |||
|
|||
The cURL client needs a :ref:`message <message-factory>` and a :ref:`stream <message-factory>` | |||
The cURL client needs a :ref:`message <message-factory>` and a :ref:`stream <stream-factory>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This could be mentioned in the installation instructions as well. See guzzle5 doc.
👍 |
2bdf91c
to
2778145
Compare
|
||
use Http\Client\Curl\Client; | ||
.. include:: includes/install-discovery.inc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sagikazarmark is this what you meant by mentioning the factories in the installation instructions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+The cURL client needs a :ref:
message factory <message-factory>
and
I meant this. If the message factory is necessary, it probably worths mentioning in the install instructions:
http://docs.php-http.org/en/latest/clients/guzzle5-adapter.html#installation
There are two include files for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
which i now include. correct like this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, missed that they are included.
LGTM IMO, go merge ? |
Those two sentences are not major ones I think. So from my point of view go ahead. |
…ustom add documentation for retry and redirect plugins, split building own, document library usage
fix #33, #35, #75
sorry, i started to mix up several things in one PR here. i hope we can solve the questions and merge things together - tried committing in parts but
git add -p
did not split into small enough bits.