From ffa21e969a03ce5cbd9a148706ec7fc8a7be03aa Mon Sep 17 00:00:00 2001 From: petersulyok Date: Thu, 14 Mar 2024 10:05:35 +0100 Subject: [PATCH] Changed: documentation improvements in introduction. --- docs/source/intro.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/intro.rst b/docs/source/intro.rst index ca26095..49a225c 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -3,7 +3,7 @@ Introduction This Python library can assist in collecting disk information on Linux. In more details, it can: - collect information about a specific disk - - explore existing disks in the system + - explore all existing disks in the system - translate between traditional and persistent disk names - read disk temperature - read SMART attributes of a disk @@ -37,13 +37,12 @@ The library has the following run-time requirements: - for reading disk partition information with :meth:`~diskinfo.Disk.get_partition_list()` method, the `df` command is required. - - optionally, `Rich Python library `_ is required for the demo + - optionally, for the demo `Rich `_ Python library is required Demo ---- -The library contains a demo application with multiple screens. The `Rich Python library `_ -must be installed for the running the demo:: +The library contains a demo application with multiple screens. In order to run demo execute the following commands:: pip install rich @@ -64,6 +63,7 @@ The third demo screen will display the SMART attributes of a specified disk:: python -m diskinfo.demo nvme0n1 -s .. image:: https://github.com/petersulyok/diskinfo/raw/main/docs/diskinfo_rich_demo_4.png + :width: 400 The fourth demo screen will display the list of partitions on a specified disk::