From 3ea45d12581bda7222a03f70ecd6d385a6f9a349 Mon Sep 17 00:00:00 2001
From: Erik Sundell <erik.i.sundell@gmail.com>
Date: Sun, 16 Oct 2022 11:03:24 +0200
Subject: [PATCH] refactor readme files: in conda tests

---
 tests/conda/README.md                         | 30 +++++++++++--------
 .../environment.yml                           |  0
 .../postBuild                                 |  0
 .../verify                                    |  0
 .../verify.py                                 |  0
 .../test-extra-args.yaml                      |  2 +-
 6 files changed, 19 insertions(+), 13 deletions(-)
 rename tests/conda/{r-postbuild-file => py-r-postbuild-file}/environment.yml (100%)
 rename tests/conda/{r-postbuild-file => py-r-postbuild-file}/postBuild (100%)
 rename tests/conda/{r-postbuild-file => py-r-postbuild-file}/verify (100%)
 rename tests/conda/{r-postbuild-file => py-r-postbuild-file}/verify.py (100%)

diff --git a/tests/conda/README.md b/tests/conda/README.md
index 5c6e1a26..15697619 100644
--- a/tests/conda/README.md
+++ b/tests/conda/README.md
@@ -1,11 +1,21 @@
 # Overview of tests for the conda buildpack
 
-## py2
+## Tested configuration files
+
+- [`.binder/`](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
+- [`requirements.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#requirements-txt-install-a-python-environment)
+- [`postBuild](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
+
+## Tested repo2docker command line flags
+
+- [`--target-repo-dir`](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
+
+### py2
 
 - Test setup of a Python 2 environment by declaring `python=2` in
   `environment.yml`.
 
-## py35-binder-dir
+### py35-binder-dir
 
 - Test setup of a Python 3.5 environment by declaring `python=3.5` in
   `environment.yml`.
@@ -14,11 +24,9 @@
   Python 3 supported by repo2docker's conda buildpack. See
   `repo2docker/buildpacks/conda` for details.
 
-- Test use of a `.binder` directory, where files outside it shouldn't be
-  considered. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
-  for details.
+- Test use of a `.binder` directory.
 
-## py310-requirements-file
+### py310-requirements-file
 
 - Test setup of a Python 3.10 environment by declaring `python=3.10` in
   `environment.yml`.
@@ -30,7 +38,7 @@
 - Test use of a `requirements.txt` file, where an `environment.yml` file should
   take precedence and the `requirements.txt` should be ignored.
 
-## r-postbuild-file
+### py-r-postbuild-file
 
 - Test setup of the default Python environment by omitting `python` from
   `environment.yml` file.
@@ -38,16 +46,14 @@
 - Test setup of the default R environment by specifying `r-base` in
   `environment.yml`.
 
-- Test use of a `postBuild` file. See [this documentation](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
-  for details.
+- Test use of a `postBuild` file.
 
-## r3.6-target-repo-dir-flag
+### r3.6-target-repo-dir-flag
 
 - Test setup of a R 3.6 environment by specifying `r-base=3.6` in
   `environment.yml`.
 
-- Test use of repo2docker with the `--target-repo-dir` flag. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
-  for details.
+- Test use of repo2docker with the `--target-repo-dir` flag.
 
   `--target-repo-dir` is meant to support custom paths where repositories can be
   copied to besides `${HOME}`.
diff --git a/tests/conda/r-postbuild-file/environment.yml b/tests/conda/py-r-postbuild-file/environment.yml
similarity index 100%
rename from tests/conda/r-postbuild-file/environment.yml
rename to tests/conda/py-r-postbuild-file/environment.yml
diff --git a/tests/conda/r-postbuild-file/postBuild b/tests/conda/py-r-postbuild-file/postBuild
similarity index 100%
rename from tests/conda/r-postbuild-file/postBuild
rename to tests/conda/py-r-postbuild-file/postBuild
diff --git a/tests/conda/r-postbuild-file/verify b/tests/conda/py-r-postbuild-file/verify
similarity index 100%
rename from tests/conda/r-postbuild-file/verify
rename to tests/conda/py-r-postbuild-file/verify
diff --git a/tests/conda/r-postbuild-file/verify.py b/tests/conda/py-r-postbuild-file/verify.py
similarity index 100%
rename from tests/conda/r-postbuild-file/verify.py
rename to tests/conda/py-r-postbuild-file/verify.py
diff --git a/tests/conda/r3.6-target-repo-dir-flag/test-extra-args.yaml b/tests/conda/r3.6-target-repo-dir-flag/test-extra-args.yaml
index 84ef1376..c30ae278 100644
--- a/tests/conda/r3.6-target-repo-dir-flag/test-extra-args.yaml
+++ b/tests/conda/r3.6-target-repo-dir-flag/test-extra-args.yaml
@@ -1,4 +1,4 @@
 # This file is respected by repo2docker's test suite, but not repo2docker
-# itself. It is used solely to help us test command line flags.
+# itself. It is used solely to help us test repo2docker's command line flags.
 #
 - --target-repo-dir=/srv/repo