Skip to content

0.11 devel docfix http response status #441

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 7 commits into from
Sep 8, 2014
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixes sphinx 'note' and 'warning' directive formatting.
  • Loading branch information
povilasb committed Sep 8, 2014
commit df6d69112de462c5968203efbf0427a4d75e3eda
12 changes: 7 additions & 5 deletions libs/network/doc/examples/http/http_client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,13 @@ You can then run this to get the Boost_ website:

.. _Boost: http://www.boost.org/

.. note:: The instructions for all these examples assume that
:mod:`cpp-netlib` is build outside the source tree,
according to `CMake conventions`_. For the sake of
consistency we assume that this is in the
``~/cpp-netlib-build`` directory.
.. note::

The instructions for all these examples assume that
:mod:`cpp-netlib` is build outside the source tree,
according to `CMake conventions`_. For the sake of
consistency we assume that this is in the
``~/cpp-netlib-build`` directory.

.. _`CMake conventions`: http://www.cmake.org/Wiki/CMake_FAQ#What_is_an_.22out-of-source.22_build.3F

Expand Down
10 changes: 6 additions & 4 deletions libs/network/doc/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,12 @@ additional parameters::
> -DCMAKE_CXX_COMPILER=g++ \
> ../cpp-netlib

.. note:: While it's not compulsory, it's recommended that
:mod:`cpp-netlib` is built outside the source directory.
For the purposes of documentation, we'll assume that all
builds are done in ``~/cpp-netlib-build``.
.. note::

While it's not compulsory, it's recommended that
:mod:`cpp-netlib` is built outside the source directory.
For the purposes of documentation, we'll assume that all
builds are done in ``~/cpp-netlib-build``.

If you intend to use the SSL support when using the HTTP client libraries in
:mod:`cpp-netlib`, you may need to build it with OpenSSL_ installed or at least
Expand Down
20 changes: 11 additions & 9 deletions libs/network/doc/reference/http_request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,15 +152,17 @@ Directives are meant to be used in the following manner:

request << directive(...);

.. warning:: There are two versions of directives, those that are applicable to
messages that support narrow strings (``std::string``) and those that are
applicable to messages that support wide strings (``std::wstring``). The
:mod:`cpp-netlib` implementation still does not convert wide strings into
UTF-8 encoded narrow strings. This will be implemented in subsequent
library releases.

For now all the implemented directives are listed, even if some of them still
do not implement things correctly.
.. warning::

There are two versions of directives, those that are applicable to
messages that support narrow strings (``std::string``) and those that are
applicable to messages that support wide strings (``std::wstring``). The
:mod:`cpp-netlib` implementation still does not convert wide strings into
UTF-8 encoded narrow strings. This will be implemented in subsequent
library releases.

For now all the implemented directives are listed, even if some of them still
do not implement things correctly.

*unspecified* ``source(std::string const & source_)``
Create a source directive with a ``std::string`` as a parameter, to be set
Expand Down