Skip to content

Commit ec669bf

Browse files
committed
[docs] Minor updates
1 parent 63a3728 commit ec669bf

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ your project, follow other topics in the menu.
4242
quickstart.rst
4343
server.rst
4444
procedure_registration.rst
45-
backends.rst
4645
authentication.rst
4746
error_handling.rst
47+
backends.rst
4848
security.rst
49-
faq.rst
5049
references.rst
50+
faq.rst
5151
migration_guide.rst
5252

5353
.. toctree::

docs/quickstart.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Create an ``RpcServer`` instance and register your first procedure
4848
return a + b
4949
5050
Remote procedures are Python functions decorated with the server's ``register_procedure`` decorator.
51-
Both server and procedure registration can be customized. See ...
51+
Both server and procedure registration can be customized. See :ref:`Procedures registration`
5252

5353
Serve the procedures
5454
--------------------
@@ -70,7 +70,7 @@ to this view in your project's ``urls.py``
7070
The server's view is already configured with CSRF exemption and POST-only restrictions.
7171

7272
Async Support
73-
^^^^^^^^^^^^
73+
^^^^^^^^^^^^^
7474

7575
For Django projects using ASGI and async views, you can use the async version of the view:
7676

@@ -100,10 +100,10 @@ directly with your favourite HTTP client
100100
.. code-block:: bash
101101
:caption: JSON-RPC example
102102
103-
~ $ curl -X POST localhost:8000/rpc -H "Content-Type: application/json" -d '{"id": 1, "method": "system.listMethods", "jsonrpc": "2.0"}'
103+
~$ curl -X POST localhost:8000/rpc -H "Content-Type: application/json" -d '{"id": 1, "method": "system.listMethods", "jsonrpc": "2.0"}'
104104
{"id": 1, "jsonrpc": "2.0", "result": ["add", "system.listMethods", "system.methodHelp", "system.methodSignature"]}
105105
106-
~ $ curl -X POST localhost:8000/rpc -H "Content-Type: application/json" -d '{"id": 2, "method": "add", "params": [5, 9], "jsonrpc": "2.0"}'
106+
~$ curl -X POST localhost:8000/rpc -H "Content-Type: application/json" -d '{"id": 2, "method": "add", "params": [5, 9], "jsonrpc": "2.0"}'
107107
{"id": 2, "jsonrpc": "2.0", "result": 14}
108108
109109
.. code-block:: python

docs/security.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ All built-in XML-RPC backends are configured with protections against XXE/DoS:
3030
- etree backend (xml.etree.ElementTree)
3131
- Uses defusedxml.ElementTree for parsing and serialization.
3232
- Forbidden constructs (DTD, entities, external references) raise defusedxml exceptions, which are translated into
33-
RPCInsecureRequest.
33+
RPCInsecureRequest.
3434
- Malformed XML raises RPCParseError.
3535

3636
- xmltodict backend
@@ -39,7 +39,7 @@ All built-in XML-RPC backends are configured with protections against XXE/DoS:
3939

4040
- lxml backend
4141
- Uses a hardened lxml.etree.XMLParser with resolve_entities=False, no_network=True, dtd_validation=False,
42-
load_dtd=False, huge_tree=False.
42+
load_dtd=False, huge_tree=False.
4343
- XMLSyntaxError is mapped to RPCParseError.
4444

4545
What you will see on insecure input

docs/server.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ to the request's protocol (JSON-RPC or XML-RPC).
2525
Protocol restriction
2626
^^^^^^^^^^^^^^^^^^^^
2727

28-
Using the ``supported_protocol`` argument, you can make sure a given server will handle only JSON-RPC or XML-RPC requests.
29-
This can be used to set up protocol-specific servers.
28+
Using the ``supported_protocol`` argument, you can configure a given server to handle only JSON-RPC or XML-RPC
29+
requests. This can be used to set up protocol-specific servers.
3030

3131
Default: ``supported_protocol = Protocol.ALL``
3232

@@ -67,7 +67,9 @@ Default: ``register_system_procedures = True``
6767
# server won't register the system.* procedures
6868
6969
.. warning::
70-
Disabling the system procedure registration may prevent some clients (in particular, XML-RPC ones) to send request to your server, use at your own risks.
70+
71+
Disabling the system procedure registration may prevent some clients (in particular, XML-RPC ones) to
72+
send request to your server, use at your own risk.
7173

7274
Authentication
7375
^^^^^^^^^^^^^^
@@ -206,4 +208,5 @@ You can create multiple server.
206208
]
207209
208210
.. warning::
211+
209212
This section needs more detailed explanation & examples

0 commit comments

Comments
 (0)