From 78b43d7224b4a314fb369086c55dbaf1ecbd55d4 Mon Sep 17 00:00:00 2001
From: Meisam Farzalipour Tabriz
 <1756-tabriz@users.noreply.gitlab.mpcdf.mpg.de>
Date: Wed, 26 Jul 2023 12:22:46 +0200
Subject: [PATCH] update docs

---
 .gitlab-ci.yml | 4 ++--
 README.md      | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index c0dc6a5..5072b71 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,5 +1,5 @@
 # This is a demo for integrating pylint results into GitLab. For more information see:
-# related Bits and Bytes article: [TODO: **BnB link**]
+# related Bits and Bytes article: https://docs.mpcdf.mpg.de/bnb/213.html
 # GitLab documentation          : https://docs.gitlab.com/ee/ci/testing/code_quality.html
 #
 # pylint        (python linter)                          : https://pylint.org
@@ -23,7 +23,7 @@ pylint:
       codequality: codeclimate.json
     when: always
   tags:
-    # run this job only on the runners with distributed cache
+    # as we're caching the installed python packages, we must run this job only on the runners with distributed cache
     - distributedcache
   cache:
     when: always
diff --git a/README.md b/README.md
index 64830f2..63f852d 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,5 @@
 
 Pylint-GitLab integration demo repository. Checkout the [accompanying Bits & Bytes article](https://docs.mpcdf.mpg.de/bnb/213.html).
 
-See [GitLab CI configuration](https://gitlab.mpcdf.mpg.de/mpcdf/training/pylint/-/blob/main/.gitlab-ci.yml) for integration details. Changes in the Pylint output can be inspected in each [merge request](https://gitlab.mpcdf.mpg.de/mpcdf/training/pylint/-/merge_requests/1). 
+See [GitLab CI configuration](https://gitlab.mpcdf.mpg.de/mpcdf/training/pylint/-/blob/main/.gitlab-ci.yml) for integration details. Changes in the Pylint output can be inspected in each [merge request](https://gitlab.mpcdf.mpg.de/mpcdf/training/pylint/-/merge_requests/2). 
 
-- 
GitLab