[doc] Describe available client options. #97

Merged
merged 3 commits into from Jan 19, 2013

Conversation

Projects
None yet
1 participant
Owner

nrk commented Dec 18, 2012

It took me a while to find a decent and concise form to describe each client option since they are inherently more complex than connection parameters due to the multitude of different values they accept, but I think (hope?) I finally reached an acceptable result.

Since most client options are strictly related to macro-arguments that will be covered through the rest of the documentation (e.g. clustering, replication, etc), I placed various cross references to other documents. Each specific document should include a section about its corresponding client option with a more extensive description focusing on some configuration scenarios or possible side effects.

Thoughts?

nrk added some commits Dec 17, 2012

@nrk nrk [doc] Describe available client options. 36671ad
@nrk nrk [doc] Fix code snippet used for client options. e4295ad
@nrk nrk [doc] Add note about client options values returned by callables.
Predis will not attempt to use its standard configuration path for
options when using callables as initializers, this makes sense and
it is an intended behavior to give users more flexibility over the
configuration of the client but it can be confusing and unexpected
in certain cases such as with the combination of server profile and
key prefix.
5034bb9

@nrk nrk added a commit that referenced this pull request Jan 19, 2013

@nrk nrk Merge pull request #97 from nrk/doc-client-options
[doc] Describe available client options.
d16bc2d

@nrk nrk merged commit d16bc2d into documentation Jan 19, 2013

nrk deleted the doc-client-options branch Jan 19, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment