]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: Random Python 3 updates
authorStephen Finucane <stephen@that.guru>
Sat, 20 Feb 2021 15:21:50 +0000 (15:21 +0000)
committerStephen Finucane <stephen@that.guru>
Sat, 20 Feb 2021 15:21:50 +0000 (15:21 +0000)
Correct some documentation examples and other things to reflect the new,
Python 3-only world.

Signed-off-by: Stephen Finucane <stephen@that.guru>
docs/api/xmlrpc.rst
docs/development/installation.rst

index 5412cce5d1558d63d819cc0ee385653f5eb53a12..73d6b915aeb37f80c0f6952d5ecc140cf9b02f88 100644 (file)
@@ -17,7 +17,7 @@ and modify information about patches, projects and more.
 .. deprecated:: 2.0
 
     The XML-RPC API is a legacy API and has been deprecated in favour of the
-    :doc:`REST API <rest/index>`. It will be removed in Patchwork 3.0.
+    :doc:`REST API <rest/index>`. It may be removed in a future release.
 
 Getting Started
 ---------------
@@ -26,18 +26,18 @@ The Patchwork XML-RPC API provides a number of "methods". Some methods require
 authentication (via HTTP Basic Auth) while others do not. Authentication uses
 your Patchwork account and the on-server documentation will indicate where it
 is necessary. We will only cover the unauthenticated method here for brevity -
-consult the `xmlrpclib`_ documentation for more detailed examples:
+consult the `xmlrpc`_ documentation for more detailed examples:
 
 To interact with the Patchwork XML-RPC API, a XML-RPC library should be used.
-Python provides such a library - `xmlrpclib`_ - in its standard library. For
+Python provides such a library - `xmlrpc`_ - in its standard library. For
 example, to get the version of the XML-RPC API for a Patchwork instance hosted
 at `patchwork.example.com`, run:
 
 .. code-block:: pycon
 
     $ python
-    >>> import xmlrpclib  # or 'xmlrpc.client' for Python 3
-    >>> rpc = xmlrpclib.ServerProxy('http://patchwork.example.com/xmlrpc/')
+    >>> import xmlrpc.client
+    >>> rpc = xmlrpc.client.ServerProxy('http://patchwork.example.com/xmlrpc/')
     >>> rpc.pw_rpc_version()
     1.1
 
@@ -61,4 +61,4 @@ where `patchwork.example.com` refers to the URL of your Patchwork instance.
    Automatic documentation generation for the Patchwork API was introduced in
    Patchwork v1.1. Prior versions of Patchwork do not offer this functionality.
 
-.. _xmlrpclib: https://docs.python.org/2/library/xmlrpclib.html
+.. _xmlrpc: https://docs.python.org/3/library/xmlrpc.html
index 244aabe6026c524e8868ce0e77ba24366a4e276e..ff81229dfbd929f131e0c624284458de254e2897 100644 (file)
@@ -231,9 +231,6 @@ packages using ``pip``:
 
    $ sudo pip install virtualenv tox
 
-If you wish to use Python 3 then simply replace ``python`` with ``python3`` in
-the above command.
-
 Configure Virtual Environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -254,8 +251,8 @@ virtual environment. This can be done like so:
 
 .. note::
 
-   If you installed a Python 3.x-based virtual environment package, adjust the
-   executable indicated above as necessary, e.g. ``virtualenv-3.7``.
+   If you wish to use a specific Python version, you can provide the
+   ``--python`` argument to use this, e.g. ``--python=python3.7``.
 
 Now install the packages. Patchwork provides three requirements files.