Skip to content

Commit f72554c

Browse files
authored
Fix typo and formatting in module http (#3208)
Fixes #3205
1 parent 79de406 commit f72554c

File tree

2 files changed

+33
-33
lines changed
  • doc/reference/reference_lua
  • locale/ru/LC_MESSAGES/reference/reference_lua

2 files changed

+33
-33
lines changed

doc/reference/reference_lua/http.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _http-module:
1+
.. _http-module:
22

33
-------------------------------------------------------------------------------
44
Module http
55
-------------------------------------------------------------------------------
66

7-
.. module:: http.client
7+
.. module:: http.client
88

99
===============================================================================
1010
Overview
@@ -20,10 +20,10 @@ It uses routines in the `libcurl <https://curl.haxx.se/libcurl/>`_ library.
2020

2121
Below is a list of all ``http`` functions.
2222

23-
.. container:: table
23+
.. container:: table
2424

25-
.. rst-class:: left-align-column-1
26-
.. rst-class:: left-align-column-2
25+
.. rst-class:: left-align-column-1
26+
.. rst-class:: left-align-column-2
2727

2828
+--------------------------------------+---------------------------------+
2929
| Name | Use |
@@ -38,9 +38,9 @@ Below is a list of all ``http`` functions.
3838
| <client_object-stat>` | |
3939
+--------------------------------------+---------------------------------+
4040

41-
.. _http-new:
41+
.. _http-new:
4242

43-
.. function:: new([options])
43+
.. function:: new([options])
4444

4545
Construct a new HTTP client instance.
4646

@@ -55,7 +55,7 @@ Below is a list of all ``http`` functions.
5555
``max_total_connections`` is the maximum number of active connections.
5656
It affects libcurl `CURLMOPT_MAX_TOTAL_CONNECTIONS <https://curl.haxx.se/libcurl/c/CURLMOPT_MAX_TOTAL_CONNECTIONS.html>`_.
5757
It is ignored if the curl version is less than 7.30.
58-
The default is 0, which allows libcurl to scale accordingly to easily handles count.
58+
The default is ``0``, which allows libcurl to scale accordingly to easily handles count.
5959

6060
The default option values are usually good enough but in rare cases it
6161
might be good to set them. In that case here are two tips.
@@ -82,17 +82,17 @@ Below is a list of all ``http`` functions.
8282

8383
**Example:**
8484

85-
.. code-block:: tarantoolsession
85+
.. code-block:: tarantoolsession
8686
8787
tarantool> http_client = require('http.client').new({max_connections = 5})
8888
---
8989
...
9090
91-
.. class:: client_object
91+
.. class:: client_object
9292

93-
.. _client_object-request:
93+
.. _client_object-request:
9494

95-
.. method:: request(method, url, body, opts)
95+
.. method:: request(method, url, body, opts)
9696

9797
If ``http_client`` is an HTTP client instance, ``http_client:request()`` will
9898
perform an HTTP request and, if there is a successful connection,
@@ -112,14 +112,14 @@ Below is a list of all ``http`` functions.
112112
will wait while the connection is idle before sending keepalive
113113
probes. See also
114114
`CURLOPT_TCP_KEEPIDLE <https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPIDLE.html>`_
115-
and the note below about keepalive_interval.
115+
and the note below about ``keepalive_interval``.
116116
* ``keepalive_interval`` -- the interval, in seconds, that the operating
117117
system will wait between sending keepalive probes. See also
118118
`CURLOPT_TCP_KEEPINTVL <https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPINTVL.html>`_.
119119
If both ``keepalive_idle`` and ``keepalive_interval`` are set, then
120120
Tarantool will also set HTTP keepalive headers: ``Connection:Keep-Alive``
121121
and ``Keep-Alive:timeout=<keepalive_idle>``.
122-
Otherwise Tarantool will send ``Connection:close``.
122+
Otherwise, Tarantool will send ``Connection:close``.
123123
* ``low_speed_limit`` -- set the "low speed limit" -- the average
124124
transfer speed in bytes per second that the transfer should be below
125125
during "low speed time" seconds for the library to consider it to be
@@ -131,7 +131,7 @@ Below is a list of all ``http`` functions.
131131
`CURLOPT_LOW_SPEED_TIME <https://curl.haxx.se/libcurl/c/CURLOPT_LOW_SPEED_TIME.html>`_.
132132
* ``max_header_name_len`` -- the maximal length of a header name. If a header
133133
name is bigger than this value, it is truncated to this length.
134-
The default value is '32'.
134+
The default value is ``32``.
135135
* ``follow_location`` -- when the option is set to ``true`` (default)
136136
and the response has a 3xx code, the HTTP client will automatically issue
137137
another request to a location that a server sends in the ``Location``
@@ -149,21 +149,21 @@ Below is a list of all ``http`` functions.
149149
without requiring a proxy, which is equivalent to setting ``proxy=''``.
150150
Set ``no_proxy = ''`` to specify that no hosts can be reached
151151
without requiring a proxy, even if a proxy-related environment variable
152-
(HTTP_PROXY) is used.
152+
(``HTTP_PROXY``) is used.
153153
If ``no_proxy`` is not set, then a proxy-related environment variable
154-
(HTTP_PROXY) may be used. See also
154+
(``HTTP_PROXY``) may be used. See also
155155
`CURLOPT_NOPROXY <https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html>`_.
156156
* ``proxy`` - a proxy server host or IP address, or ''.
157157
If ``proxy`` is a host or IP address, then it may begin with a scheme,
158158
for example ``https://`` for an https proxy or ``http://`` for an http proxy.
159159
If ``proxy`` is set to '' -- an empty string, then proxy use is disabled,
160160
and no proxy-related environment variable will be used.
161161
If ``proxy`` is not set, then a proxy-related environment variable may be used, such as
162-
HTTP_PROXY or HTTPS_PROXY or FTP_PROXY, or ALL_PROXY if the
162+
``HTTP_PROXY`` or ``HTTPS_PROXY`` or ``FTP_PROXY``, or ``ALL_PROXY`` if the
163163
protocol can be any protocol. See also
164164
`CURLOPT_PROXY <https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html>`_.
165165
* ``proxy_port`` -- a proxy server port.
166-
The default is 443 for an https proxy and 1080 for a non-https proxy.
166+
The default is ``443`` for an https proxy and ``1080`` for a non-https proxy.
167167
See also
168168
`CURLOPT_PROXYPORT <https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPORT.html>`_.
169169
* ``proxy_user_pwd`` -- a proxy server user name and/or password.
@@ -272,7 +272,7 @@ Below is a list of all ``http`` functions.
272272
``http_client:request("DELETE", url, nil, opts)``
273273
* ``http_client:trace(url, options)`` -- shortcut for
274274
``http_client:request("TRACE", url, nil, opts)``
275-
* ``http_client:connect:(url, options)`` -- shortcut for
275+
* ``http_client:connect(url, options)`` -- shortcut for
276276
``http_client:request("CONNECT", url, nil, opts)``
277277

278278
Requests may be influenced by environment variables, for example

locale/ru/LC_MESSAGES/reference/reference_lua/http.po

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -271,22 +271,22 @@ msgid ""
271271
"while the connection is idle before sending keepalive probes. See also "
272272
"`CURLOPT_TCP_KEEPIDLE "
273273
"<https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPIDLE.html>`_ and the note "
274-
"below about keepalive_interval."
274+
"below about ``keepalive_interval``."
275275
msgstr ""
276276
"``keepalive_idle`` -- время задержки в секундах, в течение которого "
277277
"операционная система находится в режиме ожидания подключения до отправки "
278278
"сообщений для поддержания в активном состоянии keepalive. См. также "
279279
"`CURLOPT_TCP_KEEPIDLE "
280280
"<https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPIDLE.html>`_ и примечание "
281-
"ниже к keepalive_interval."
281+
"ниже к ``keepalive_interval``."
282282

283283
msgid ""
284284
"``keepalive_interval`` -- the interval, in seconds, that the operating system"
285285
" will wait between sending keepalive probes. See also `CURLOPT_TCP_KEEPINTVL"
286286
" <https://curl.haxx.se/libcurl/c/CURLOPT_TCP_KEEPINTVL.html>`_. If both "
287287
"``keepalive_idle`` and ``keepalive_interval`` are set, then Tarantool will "
288288
"also set HTTP keepalive headers: ``Connection:Keep-Alive`` and ``Keep-"
289-
"Alive:timeout=<keepalive_idle>``. Otherwise Tarantool will send "
289+
"Alive:timeout=<keepalive_idle>``. Otherwise, Tarantool will send "
290290
"``Connection:close``."
291291
msgstr ""
292292

@@ -318,11 +318,11 @@ msgstr ""
318318
msgid ""
319319
"``max_header_name_len`` -- the maximal length of a header name. If a header "
320320
"name is bigger than this value, it is truncated to this length. The default "
321-
"value is '32'."
321+
"value is ``32``."
322322
msgstr ""
323323
"``max_header_name_len`` -- максимальная длина имени заголовка. Если имя "
324324
"заголовка больше данного значения, оно усекается до такой длины. По "
325-
"умолчанию, '32'."
325+
"умолчанию, ``32``."
326326

327327
msgid ""
328328
"``follow_location`` -- when the option is set to ``true`` (default) and the "
@@ -343,9 +343,9 @@ msgid ""
343343
"been set. Set ``no__proxy = '*'`` to specify that all hosts can be reached "
344344
"without requiring a proxy, which is equivalent to setting ``proxy=''``. Set "
345345
"``no_proxy = ''`` to specify that no hosts can be reached without requiring "
346-
"a proxy, even if a proxy-related environment variable (HTTP_PROXY) is used. "
346+
"a proxy, even if a proxy-related environment variable (``HTTP_PROXY``) is used. "
347347
"If ``no_proxy`` is not set, then a proxy-related environment variable "
348-
"(HTTP_PROXY) may be used. See also `CURLOPT_NOPROXY "
348+
"(``HTTP_PROXY``) may be used. See also `CURLOPT_NOPROXY "
349349
"<https://curl.haxx.se/libcurl/c/CURLOPT_NOPROXY.html>`_."
350350
msgstr ""
351351

@@ -355,14 +355,14 @@ msgid ""
355355
"for an https proxy or ``http://`` for an http proxy. If ``proxy`` is set to "
356356
"'' -- an empty string, then proxy use is disabled, and no proxy-related "
357357
"environment variable will be used. If ``proxy`` is not set, then a proxy-"
358-
"related environment variable may be used, such as HTTP_PROXY or HTTPS_PROXY "
359-
"or FTP_PROXY, or ALL_PROXY if the protocol can be any protocol. See also "
358+
"related environment variable may be used, such as ``HTTP_PROXY`` or ``HTTPS_PROXY`` "
359+
"or ``FTP_PROXY``, or ``ALL_PROXY`` if the protocol can be any protocol. See also "
360360
"`CURLOPT_PROXY <https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html>`_."
361361
msgstr ""
362362

363363
msgid ""
364-
"``proxy_port`` -- a proxy server port. The default is 443 for an https proxy"
365-
" and 1080 for a non-https proxy. See also `CURLOPT_PROXYPORT "
364+
"``proxy_port`` -- a proxy server port. The default is ``443`` for an https proxy"
365+
" and ``1080`` for a non-https proxy. See also `CURLOPT_PROXYPORT "
366366
"<https://curl.haxx.se/libcurl/c/CURLOPT_PROXYPORT.html>`_."
367367
msgstr ""
368368

@@ -607,10 +607,10 @@ msgstr ""
607607
"``http_client:request(\"TRACE\", url, nil, opts)``"
608608

609609
msgid ""
610-
"``http_client:connect:(url, options)`` -- shortcut for "
610+
"``http_client:connect(url, options)`` -- shortcut for "
611611
"``http_client:request(\"CONNECT\", url, nil, opts)``"
612612
msgstr ""
613-
"``http_client:connect:(url, options)`` -- ускоренный метод для "
613+
"``http_client:connect(url, options)`` -- ускоренный метод для "
614614
"``http_client:request(\"CONNECT\", url, nil, opts)``"
615615

616616
msgid ""

0 commit comments

Comments
 (0)