From cba22b7d19132d6dace601cf37d98c58d86478fd Mon Sep 17 00:00:00 2001
From: "Antoine R. Dumont (@ardumont)" <antoine.romain.dumont@gmail.com>
Date: Thu, 6 Sep 2018 14:58:03 +0200
Subject: [PATCH] doc: Fix typos according to review

---
 README.md                            | 10 +++++-----
 swh/lister/core/lister_transports.py |  4 ++--
 swh/lister/pypi/lister.py            |  1 -
 3 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index d3d0240..0607ce4 100644
--- a/README.md
+++ b/README.md
@@ -64,7 +64,7 @@ Minimalistic configuration:
     lister_db_url: postgres:///lister-github
     credentials: []
     cache_responses: True
-    cache_dir: /home/zack/.cache/swh/lister/github.com
+    cache_dir: /home/user/.cache/swh/lister/github.com
 
 Note: This expects storage (5002) and scheduler (5008) services to run locally
 
@@ -102,7 +102,7 @@ Note: This expects storage (5002) and scheduler (5008) services to run locally
     lister_db_url: postgres:///lister-gitlab
     credentials: []
     cache_responses: True
-    cache_dir: /home/zack/.cache/swh/lister/gitlab
+    cache_dir: /home/user/.cache/swh/lister/gitlab
 
 Note: This expects storage (5002) and scheduler (5008) services to run locally
 
@@ -145,7 +145,7 @@ Note: This expects storage (5002) and scheduler (5008) services to run locally
     lister_db_url: postgres:///lister-debian
     credentials: []
     cache_responses: True
-    cache_dir: /home/zack/.cache/swh/lister/debian
+    cache_dir: /home/user/.cache/swh/lister/debian
 
 Note: This expects storage (5002) and scheduler (5008) services to run locally
 
@@ -163,7 +163,7 @@ Note: This expects storage (5002) and scheduler (5008) services to run locally
   ...
 
 
-## lister-debian
+## lister-pypi
 
 ### preparation steps
 
@@ -188,7 +188,7 @@ Note: This expects storage (5002) and scheduler (5008) services to run locally
     lister_db_url: postgres:///lister-pypi
     credentials: []
     cache_responses: True
-    cache_dir: /home/zack/.cache/swh/lister/pypi
+    cache_dir: /home/user/.cache/swh/lister/pypi
 
 Note: This expects storage (5002) and scheduler (5008) services to run locally
 
diff --git a/swh/lister/core/lister_transports.py b/swh/lister/core/lister_transports.py
index a1f346c..ef59b6f 100644
--- a/swh/lister/core/lister_transports.py
+++ b/swh/lister/core/lister_transports.py
@@ -211,8 +211,8 @@ class SWHListerHttpTransport(abc.ABC):
 
 
 class ListerOnePageApiTransport(SWHListerHttpTransport):
-    """Use the request library for retrieving a basic html page and parse
-       the result.
+    """Leverage requests library to retrieve basic html page and parse
+       result.
 
        To be used in conjunction with SWHListerBase or a subclass of it.
 
diff --git a/swh/lister/pypi/lister.py b/swh/lister/pypi/lister.py
index 4f7c55e..6d04d78 100644
--- a/swh/lister/pypi/lister.py
+++ b/swh/lister/pypi/lister.py
@@ -13,7 +13,6 @@ from swh.lister.core.lister_transports import ListerOnePageApiTransport
 
 
 class PyPiLister(ListerOnePageApiTransport, SimpleLister):
-    # Template path expecting an integer that represents the page id
     MODEL = PyPiModel
     LISTER_NAME = 'pypi'
     PAGE = 'https://pypi.org/simple/'