From 18a0c0191e4cfd01d77d01c3c8e419c8b4576c2c Mon Sep 17 00:00:00 2001 From: svalouch Date: Tue, 6 Oct 2020 22:02:56 +0200 Subject: [PATCH] docs: fix pip url and line length in quickstart --- docs/quickstart.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 38a6fe9..2fb6128 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -10,9 +10,9 @@ From the repo You can pull the code from the repository at URL using pip: -.. code-block:: bash +:: - pip install git+ssh://URL/python-simplezfs + pip install git+https://github.com/svalouch/python-simplezfs#egg=simplezfs Interfaces @@ -22,17 +22,17 @@ For both ``zfs(8)`` and ``zpool(8)`` there exist two interfaces: * **cli** calls the ``zfs`` and ``zpool`` binaries in subprocesses * **native** uses ``libzfs_core`` to achieve the same goals -There exist two functions :func:`~simplezfs.zfs.get_zfs` and :func:`~simplezfs.zpool.get_zpool` that take the implementation as -first argument and return the appropriate implementation. The main documentation about how it works are in the api -documentation for the interface classes :class:`~simplezfs.zfs.ZFS` and :class:`~simplezfs.zpool.ZPool`. +There exist two functions :func:`~simplezfs.zfs.get_zfs` and :func:`~simplezfs.zpool.get_zpool` that take the +implementation as first argument and return the appropriate implementation. The main documentation about how it works +are in the api documentation for the interface classes :class:`~simplezfs.zfs.ZFS` and :class:`~simplezfs.zpool.ZPool`. This guide focuses on the ``cli`` variants. It is not strictly neccessary to get and pass around an instance every time, as the classes hold very little state. They need to do some initialization however, such as finding the binaries (and thus hitting the local filesystem). -For the rest of the guide, we'll assume that the following has been run and we have a :class:`~simplezfs.zfs.ZFS` instance -in ``zfs``: +For the rest of the guide, we'll assume that the following has been run and we have a :class:`~simplezfs.zfs.ZFS` +instance in ``zfs``: .. code-block:: pycon