From ab4bd470436eed761841bd10416ad46b66234f5e Mon Sep 17 00:00:00 2001 From: Conor MacBride Date: Sat, 5 Feb 2022 21:47:08 +0000 Subject: [PATCH] Document `--mpl-baseline-relative` --- README.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a81b8322..ea76006b 100644 --- a/README.rst +++ b/README.rst @@ -188,8 +188,11 @@ running tests by running ``pytest`` with:: pytest --mpl --mpl-baseline-path=baseline_images -This directory will be interpreted as being relative to where the tests -are run. In addition, if both this option and the ``baseline_dir`` +This directory will be interpreted as being relative to where pytest +is run. However, if the ``--mpl-baseline-relative`` option is also +included, this directory will be interpreted as being relative to +the current test directory. +In addition, if both this option and the ``baseline_dir`` option in the ``mpl_image_compare`` decorator are used, the one in the decorator takes precedence.