Errors to docstring - readme lint test

nf-core · Dec 11, 2020 · 609e28e · 609e28e
1 parent b28eb12
commit 609e28e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 23 deletions.
diff --git a/docs/lint_errors.md b/docs/lint_errors.md
@@ -69,27 +69,6 @@ The following variables are depreciated and fail the test if they are still pres
 Process-level configuration syntax is checked and fails if uses the old Nextflow syntax, for example:
 `process.$fastqc` instead of `process withName:'fastqc'`.
 
-## Error #6 - Repository `README.md` tests ## {#6}
-
-The `README.md` files for a project are very important and must meet some requirements:
-
-* Nextflow badge
-  * If no Nextflow badge is found, a warning is given
-  * If a badge is found but the version doesn't match the minimum version in the config file, the test fails
-  * Example badge code:
-
-    ```markdown
-    [![Nextflow](https://img.shields.io/badge/nextflow-%E2%89%A50.27.6-brightgreen.svg)](https://www.nextflow.io/)
-    ```
-
-* Bioconda badge
-  * If your pipeline contains a file called `environment.yml`, a bioconda badge is required
-  * Required badge code:
-
-    ```markdown
-    [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](https://bioconda.github.io/)
-    ```
-
 ## Error #7 - Pipeline and container version numbers ## {#7}
 
 > This test only runs when `--release` is set or `$GITHUB_REF` is equal to `master`

diff --git a/nf_core/lint/readme.py b/nf_core/lint/readme.py
@@ -5,9 +5,30 @@
 
 
 def readme(self):
-    """Checks the repository README file for errors.
+    """Repository ``README.md`` tests
 
-    Currently just checks the badges at the top of the README.
+    The ``README.md`` files for a project are very important and must meet some requirements:
+
+    * Nextflow badge
+
+      * If no Nextflow badge is found, a warning is given
+      * If a badge is found but the version doesn't match the minimum version in the config file, the test fails
+      * Example badge code:
+
+        .. code-block:: md
+
+           [![Nextflow](https://img.shields.io/badge/nextflow-%E2%89%A50.27.6-brightgreen.svg)](https://www.nextflow.io/)
+
+    * Bioconda badge
+
+      * If your pipeline contains a file called ``environment.yml`` in the root directory, a bioconda badge is required
+      * Required badge code:
+
+        .. code-block:: md
+
+           [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg)](https://bioconda.github.io/)
+
+    .. note:: These badges are a markdown image (``![alt-text](<image URL>)``) *inside* a markdown link (``[markdown image](<link URL>)``), so a bit fiddly.
     """
     passed = []
     warned = []