MAINT: Put more meaningful configuration info

airspeed-velocity · Feb 11, 2024 · a44babd · a44babd
1 parent b670f26
commit a44babd
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 16 deletions.
diff --git a/readme.md b/readme.md
@@ -14,14 +14,17 @@ demonstration.
 
 ## Representative Build Systems
 
-| **Branch**                   | **Configuration**                | **CI Status**                                                                                                                                                                                                                                       |
-|------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `main`                       | Source, not to be run            | N/A                                                                                                                                                                                                                                                 |
-| `setup.py-build`             | Setuptools with `setup.py`       | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)                         |
-| `pyproject-setuptools-build` | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build) |
-| `memray-plugin`              | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)                           |
-| `decorator-params`           | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)                     |
-| `skip-params`                | Setuptools with `pyproject.toml` | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)                               |
++CAPTION: Where not specified, `pyproject.toml` is coupled with `hatch`
+and `hatchling`
+
+| **Branch**                   | **Configuration**                          | **CI Status**                                                                                                                                                                                                                                       |
+|------------------------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `main`                       | Source, not to be run                      | N/A                                                                                                                                                                                                                                                 |
+| `setup.py-build`             | Setuptools with `setup.py`                 | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)                         |
+| `pyproject-setuptools-build` | Setuptools with `pyproject.toml`           | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build) |
+| `memray-plugin`              | `memray` usage for peak memory             | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)                           |
+| `decorator-params`           | Decorators for simpler parametrization     | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)                     |
+| `skip-params`                | Various benchmark / parameter skip methods | [![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)                               |
 
 Note that in all cases users can always modify the `build_command`
 variable within their `asv` configuration file.

diff --git a/readme_src.org b/readme_src.org
@@ -11,14 +11,15 @@ The repository is structured with dedicated branches for each build system and
 feature demonstration.
 ** Representative Build Systems
 
-| *Branch*                     | *Configuration*                  | *CI Status*                                                                                                                                 |
-|------------------------------+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------|
-| ~main~                       | Source, not to be run            | N/A                                                                                                                                         |
-| ~setup.py-build~             | Setuptools with ~setup.py~       | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)@@             |
-| ~pyproject-setuptools-build~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build)@@ |
-| ~memray-plugin~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)@@ |
-| ~decorator-params~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)@@ |
-| ~skip-params~ | Setuptools with ~pyproject.toml~ | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)@@ |
++CAPTION: Where not specified, ~pyproject.toml~ is coupled with ~hatch~ and ~hatchling~
+| *Branch*                     | *Configuration*                            | *CI Status*                                                                                                                                                                                                                                                      |
+|------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ~main~                       | Source, not to be run                      | N/A                                                                                                                                                                                                                                                              |
+| ~setup.py-build~             | Setuptools with ~setup.py~                 | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=setup.py-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Asetup.py-build)@@                         |
+| ~pyproject-setuptools-build~ | Setuptools with ~pyproject.toml~           | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=pyproject-setuptools-build)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Apyproject-setuptools-build)@@ |
+| ~memray-plugin~              | ~memray~ usage for peak memory             | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=memray-plugin)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Amemray-plugin)@@                           |
+| ~decorator-params~           | Decorators for simpler parametrization     | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=decorator-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Adecorator-params)@@                     |
+| ~skip-params~                | Various benchmark / parameter skip methods | @@markdown:[![Status](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml/badge.svg?branch=skip-params)](https://github.com/HaoZeke/asv_samples/actions/workflows/build_test.yml?query=branch%3Askip-params)@@                               |
 
 Note that in all cases users can always modify the ~build_command~ variable
 within their ~asv~ configuration file.